sys/boot/i386/loader/main.c

   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
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 /*
  31  * MD bootstrap main() and assorted miscellaneous
  32  * commands.
  33  */
  34
  35 #include <stand.h>
  36 #include <string.h>
  37 #include <machine/bootinfo.h>
  38 #include <machine/psl.h>
  39 #include <sys/reboot.h>
  40
  41 #include "bootstrap.h"
  42 #include "libi386/libi386.h"
  43 #include "btxv86.h"
  44
  45 #define KARGS_FLAGS_CD          0x1
  46 #define KARGS_FLAGS_PXE         0x2
  47 #define KARGS_FLAGS_ZFS         0x4
  48
  49 /* Arguments passed in from the boot1/boot2 loader */
  50 static struct
  51 {
  52     u_int32_t   howto;
  53     u_int32_t   bootdev;
  54     u_int32_t   bootflags;
  55     union {
  56         struct {
  57             u_int32_t   pxeinfo;
  58             u_int32_t   res2;
  59         };
  60         uint64_t        zfspool;
  61     };
  62     u_int32_t   bootinfo;
  63 } *kargs;
  64
  65 static u_int32_t        initial_howto;
  66 static u_int32_t        initial_bootdev;
  67 static struct bootinfo  *initial_bootinfo;
  68
  69 struct arch_switch      archsw;         /* MI/MD interface boundary */
  70
  71 static void             extract_currdev(void);
  72 static int              isa_inb(int port);
  73 static void             isa_outb(int port, int value);
  74 void                    exit(int code);
  75
  76 /* from vers.c */
  77 extern  char bootprog_name[], bootprog_rev[], bootprog_date[], bootprog_maker[];
  78
  79 /* XXX debugging */
  80 extern char end[];
  81
  82 static void *heap_top;
  83 static void *heap_bottom;
  84
  85 int
  86 main(void)
  87 {
  88     int                 i;
  89
  90     /* Pick up arguments */
  91     kargs = (void *)__args;
  92     initial_howto = kargs->howto;
  93     initial_bootdev = kargs->bootdev;
  94     initial_bootinfo = kargs->bootinfo ? (struct bootinfo *)PTOV(kargs->bootinfo) : NULL;
  95
  96     /* Initialize the v86 register set to a known-good state. */
  97     bzero(&v86, sizeof(v86));
  98     v86.efl = PSL_RESERVED_DEFAULT | PSL_I;
  99
 100     /*
 101      * Initialise the heap as early as possible.  Once this is done, malloc() is usable.
 102      */
 103     bios_getmem();
 104
 105 #if defined(LOADER_BZIP2_SUPPORT) || defined(LOADER_FIREWIRE_SUPPORT) || defined(LOADER_GPT_SUPPORT) || defined(LOADER_ZFS_SUPPORT)
 106     heap_top = PTOV(memtop_copyin);
 107     memtop_copyin -= 0x300000;
 108     heap_bottom = PTOV(memtop_copyin);
 109 #else
 110     heap_top = (void *)bios_basemem;
 111     heap_bottom = (void *)end;
 112 #endif
 113     setheap(heap_bottom, heap_top);
 114
 115     /*
 116      * XXX Chicken-and-egg problem; we want to have console output early, but some
 117      * console attributes may depend on reading from eg. the boot device, which we
 118      * can't do yet.
 119      *
 120      * We can use printf() etc. once this is done.
 121      * If the previous boot stage has requested a serial console, prefer that.
 122      */
 123     bi_setboothowto(initial_howto);
 124     if (initial_howto & RB_MULTIPLE) {
 125         if (initial_howto & RB_SERIAL)
 126             setenv("console", "comconsole vidconsole", 1);
 127         else
 128             setenv("console", "vidconsole comconsole", 1);
 129     } else if (initial_howto & RB_SERIAL)
 130         setenv("console", "comconsole", 1);
 131     else if (initial_howto & RB_MUTE)
 132         setenv("console", "nullconsole", 1);
 133     cons_probe();
 134
 135     /*
 136      * Initialise the block cache
 137      */
 138     bcache_init(32, 512);       /* 16k cache XXX tune this */
 139
 140     /*
 141      * Special handling for PXE and CD booting.
 142      */
 143     if (kargs->bootinfo == 0) {
 144         /*
 145          * We only want the PXE disk to try to init itself in the below
 146          * walk through devsw if we actually booted off of PXE.
 147          */
 148         if (kargs->bootflags & KARGS_FLAGS_PXE)
 149             pxe_enable(kargs->pxeinfo ? PTOV(kargs->pxeinfo) : NULL);
 150         else if (kargs->bootflags & KARGS_FLAGS_CD)
 151             bc_add(initial_bootdev);
 152     }
 153
 154     archsw.arch_autoload = i386_autoload;
 155     archsw.arch_getdev = i386_getdev;
 156     archsw.arch_copyin = i386_copyin;
 157     archsw.arch_copyout = i386_copyout;
 158     archsw.arch_readin = i386_readin;
 159     archsw.arch_isainb = isa_inb;
 160     archsw.arch_isaoutb = isa_outb;
 161
 162     /*
 163      * March through the device switch probing for things.
 164      */
 165     for (i = 0; devsw[i] != NULL; i++)
 166         if (devsw[i]->dv_init != NULL)
 167             (devsw[i]->dv_init)();
 168     printf("BIOS %dkB/%dkB available memory\n", bios_basemem / 1024, bios_extmem / 1024);
 169     if (initial_bootinfo != NULL) {
 170         initial_bootinfo->bi_basemem = bios_basemem / 1024;
 171         initial_bootinfo->bi_extmem = bios_extmem / 1024;
 172     }
 173
 174     /* detect ACPI for future reference */
 175     biosacpi_detect();
 176
 177     /* detect SMBIOS for future reference */
 178     smbios_detect();
 179
 180     printf("\n");
 181     printf("%s, Revision %s\n", bootprog_name, bootprog_rev);
 182     printf("(%s, %s)\n", bootprog_maker, bootprog_date);
 183
 184     extract_currdev();                          /* set $currdev and $loaddev */
 185     setenv("LINES", "24", 1);                   /* optional */
 186
 187     bios_getsmap();
 188
 189     interact();                 /* doesn't return */
 190
 191     /* if we ever get here, it is an error */
 192     return (1);
 193 }
 194
 195 /*
 196  * Set the 'current device' by (if possible) recovering the boot device as
 197  * supplied by the initial bootstrap.
 198  *
 199  * XXX should be extended for netbooting.
 200  */
 201 static void
 202 extract_currdev(void)
 203 {
 204     struct i386_devdesc new_currdev;
 205     int                 biosdev = -1;
 206
 207     /* Assume we are booting from a BIOS disk by default */
 208     new_currdev.d_dev = &biosdisk;
 209
 210     /* new-style boot loaders such as pxeldr and cdldr */
 211     if (kargs->bootinfo == 0) {
 212         if ((kargs->bootflags & KARGS_FLAGS_CD) != 0) {
 213             /* we are booting from a CD with cdboot */
 214             new_currdev.d_dev = &bioscd;
 215             new_currdev.d_unit = bc_bios2unit(initial_bootdev);
 216         } else if ((kargs->bootflags & KARGS_FLAGS_PXE) != 0) {
 217             /* we are booting from pxeldr */
 218             new_currdev.d_dev = &pxedisk;
 219             new_currdev.d_unit = 0;
 220         } else {
 221             /* we don't know what our boot device is */
 222             new_currdev.d_kind.biosdisk.slice = -1;
 223             new_currdev.d_kind.biosdisk.partition = 0;
 224             biosdev = -1;
 225         }
 226     } else if ((initial_bootdev & B_MAGICMASK) != B_DEVMAGIC) {
 227         /* The passed-in boot device is bad */
 228         new_currdev.d_kind.biosdisk.slice = -1;
 229         new_currdev.d_kind.biosdisk.partition = 0;
 230         biosdev = -1;
 231     } else {
 232         new_currdev.d_kind.biosdisk.slice = B_SLICE(initial_bootdev) - 1;
 233         new_currdev.d_kind.biosdisk.partition = B_PARTITION(initial_bootdev);
 234         biosdev = initial_bootinfo->bi_bios_dev;
 235
 236         /*
 237          * If we are booted by an old bootstrap, we have to guess at the BIOS
 238          * unit number.  We will lose if there is more than one disk type
 239          * and we are not booting from the lowest-numbered disk type
 240          * (ie. SCSI when IDE also exists).
 241          */
 242         if ((biosdev == 0) && (B_TYPE(initial_bootdev) != 2))   /* biosdev doesn't match major */
 243             biosdev = 0x80 + B_UNIT(initial_bootdev);           /* assume harddisk */
 244     }
 245     new_currdev.d_type = new_currdev.d_dev->dv_type;
 246
 247     /*
 248      * If we are booting off of a BIOS disk and we didn't succeed in determining
 249      * which one we booted off of, just use disk0: as a reasonable default.
 250      */
 251     if ((new_currdev.d_type == biosdisk.dv_type) &&
 252         ((new_currdev.d_unit = bd_bios2unit(biosdev)) == -1)) {
 253         printf("Can't work out which disk we are booting from.\n"
 254                "Guessed BIOS device 0x%x not found by probes, defaulting to disk0:\n", biosdev);
 255         new_currdev.d_unit = 0;
 256     }
 257     env_setenv("currdev", EV_VOLATILE, i386_fmtdev(&new_currdev),
 258                i386_setcurrdev, env_nounset);
 259     env_setenv("loaddev", EV_VOLATILE, i386_fmtdev(&new_currdev), env_noset,
 260                env_nounset);
 261
 262 #ifdef LOADER_ZFS_SUPPORT
 263     /*
 264      * If we were started from a ZFS-aware boot2, we can work out
 265      * which ZFS pool we are booting from.
 266      */
 267     if (kargs->bootflags & KARGS_FLAGS_ZFS) {
 268         /*
 269          * Dig out the pool guid and convert it to a 'unit number'
 270          */
 271         uint64_t guid;
 272         int unit;
 273         char devname[32];
 274         extern int zfs_guid_to_unit(uint64_t);
 275
 276         guid = kargs->zfspool;
 277         unit = zfs_guid_to_unit(guid);
 278         if (unit >= 0) {
 279             sprintf(devname, "zfs%d", unit);
 280             setenv("currdev", devname, 1);
 281         }
 282     }
 283 #endif
 284 }
 285
 286 COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot);
 287
 288 static int
 289 command_reboot(int argc, char *argv[])
 290 {
 291     int i;
 292
 293     for (i = 0; devsw[i] != NULL; ++i)
 294         if (devsw[i]->dv_cleanup != NULL)
 295             (devsw[i]->dv_cleanup)();
 296
 297     printf("Rebooting...\n");
 298     delay(1000000);
 299     __exit(0);
 300 }
 301
 302 /* provide this for panic, as it's not in the startup code */
 303 void
 304 exit(int code)
 305 {
 306     __exit(code);
 307 }
 308
 309 COMMAND_SET(heap, "heap", "show heap usage", command_heap);
 310
 311 static int
 312 command_heap(int argc, char *argv[])
 313 {
 314     mallocstats();
 315     printf("heap base at %p, top at %p, upper limit at %p\n", heap_bottom,
 316       sbrk(0), heap_top);
 317     return(CMD_OK);
 318 }
 319
 320 /* ISA bus access functions for PnP, derived from <machine/cpufunc.h> */
 321 static int
 322 isa_inb(int port)
 323 {
 324     u_char      data;
 325
 326     if (__builtin_constant_p(port) &&
 327         (((port) & 0xffff) < 0x100) &&
 328         ((port) < 0x10000)) {
 329         __asm __volatile("inb %1,%0" : "=a" (data) : "id" ((u_short)(port)));
 330     } else {
 331         __asm __volatile("inb %%dx,%0" : "=a" (data) : "d" (port));
 332     }
 333     return(data);
 334 }
 335
 336 static void
 337 isa_outb(int port, int value)
 338 {
 339     u_char      al = value;
 340
 341     if (__builtin_constant_p(port) &&
 342         (((port) & 0xffff) < 0x100) &&
 343         ((port) < 0x10000)) {
 344         __asm __volatile("outb %0,%1" : : "a" (al), "id" ((u_short)(port)));
 345     } else {
 346         __asm __volatile("outb %0,%%dx" : : "a" (al), "d" (port));
 347     }
 348 }
 349