NetBSD-5.0.2/sys/arch/i386/stand/boot/boot2.c
/* $NetBSD: boot2.c,v 1.38 2008/10/11 11:06:19 joerg Exp $ */
/*-
* Copyright (c) 2008 The NetBSD Foundation, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Copyright (c) 2003
* David Laight. All rights reserved
* Copyright (c) 1996, 1997, 1999
* Matthias Drochner. All rights reserved.
* Copyright (c) 1996, 1997
* Perry E. Metzger. All rights reserved.
* Copyright (c) 1997
* Jason R. Thorpe. All rights reserved
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgements:
* This product includes software developed for the NetBSD Project
* by Matthias Drochner.
* This product includes software developed for the NetBSD Project
* by Perry E. Metzger.
* 4. The names of the authors may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/* Based on stand/biosboot/main.c */
#include <sys/types.h>
#include <sys/reboot.h>
#include <sys/bootblock.h>
#include <lib/libsa/stand.h>
#include <lib/libsa/ufs.h>
#include <lib/libkern/libkern.h>
#include <libi386.h>
#include "devopen.h"
#include "bootmod.h"
#ifdef SUPPORT_PS2
#include <biosmca.h>
#endif
extern struct x86_boot_params boot_params;
extern const char bootprog_name[], bootprog_rev[], bootprog_kernrev[];
int errno;
int boot_biosdev;
u_int boot_biossector;
static const char * const names[][2] = {
{ "netbsd", "netbsd.gz" },
{ "onetbsd", "onetbsd.gz" },
{ "netbsd.old", "netbsd.old.gz" },
};
#define NUMNAMES (sizeof(names)/sizeof(names[0]))
#define DEFFILENAME names[0][0]
#define MAXDEVNAME 16
#ifndef SMALL
#define BOOTCONF "boot.cfg"
#define MAXMENU 20
#define MAXBANNER 12
#define COMMAND_SEPARATOR ';'
#endif /* !SMALL */
static char *default_devname;
static int default_unit, default_partition;
static const char *default_filename;
char *sprint_bootsel(const char *);
void bootit(const char *, int, int);
void print_banner(void);
void boot2(int, u_int);
#ifndef SMALL
void parsebootconf(const char *);
void doboottypemenu(void);
int atoi(const char *);
#endif /* !SMALL */
void command_help(char *);
void command_ls(char *);
void command_quit(char *);
void command_boot(char *);
void command_dev(char *);
void command_consdev(char *);
void command_modules(char *);
void command_load(char *);
void command_multiboot(char *);
const struct bootblk_command commands[] = {
{ "help", command_help },
{ "?", command_help },
{ "ls", command_ls },
{ "quit", command_quit },
{ "boot", command_boot },
{ "dev", command_dev },
{ "consdev", command_consdev },
{ "modules", command_modules },
{ "load", command_load },
{ "multiboot", command_multiboot },
{ NULL, NULL },
};
#ifndef SMALL
#define MENUFORMAT_AUTO 0
#define MENUFORMAT_NUMBER 1
#define MENUFORMAT_LETTER 2
struct bootconf_def {
char *banner[MAXBANNER]; /* Banner text */
char *command[MAXMENU]; /* Menu commands per entry*/
char *consdev; /* Console device */
int def; /* Default menu option */
char *desc[MAXMENU]; /* Menu text per entry */
int nummenu; /* Number of menu items */
int timeout; /* Timeout in seconds */
int menuformat; /* Print letters instead of numbers? */
} bootconf;
#endif /* !SMALL */
int
parsebootfile(const char *fname, char **fsname, char **devname,
int *unit, int *partition, const char **file)
{
const char *col;
*fsname = "ufs";
*devname = default_devname;
*unit = default_unit;
*partition = default_partition;
*file = default_filename;
if (fname == NULL)
return 0;
if ((col = strchr(fname, ':')) != NULL) { /* device given */
static char savedevname[MAXDEVNAME+1];
int devlen;
int u = 0, p = 0;
int i = 0;
devlen = col - fname;
if (devlen > MAXDEVNAME)
return EINVAL;
#define isvalidname(c) ((c) >= 'a' && (c) <= 'z')
if (!isvalidname(fname[i]))
return EINVAL;
do {
savedevname[i] = fname[i];
i++;
} while (isvalidname(fname[i]));
savedevname[i] = '\0';
#define isnum(c) ((c) >= '0' && (c) <= '9')
if (i < devlen) {
if (!isnum(fname[i]))
return EUNIT;
do {
u *= 10;
u += fname[i++] - '0';
} while (isnum(fname[i]));
}
#define isvalidpart(c) ((c) >= 'a' && (c) <= 'z')
if (i < devlen) {
if (!isvalidpart(fname[i]))
return EPART;
p = fname[i++] - 'a';
}
if (i != devlen)
return ENXIO;
*devname = savedevname;
*unit = u;
*partition = p;
fname = col + 1;
}
if (*fname)
*file = fname;
return 0;
}
char *
sprint_bootsel(const char *filename)
{
char *fsname, *devname;
int unit, partition;
const char *file;
static char buf[80];
if (parsebootfile(filename, &fsname, &devname, &unit,
&partition, &file) == 0) {
sprintf(buf, "%s%d%c:%s", devname, unit, 'a' + partition, file);
return buf;
}
return "(invalid)";
}
void
bootit(const char *filename, int howto, int tell)
{
if (tell) {
printf("booting %s", sprint_bootsel(filename));
if (howto)
printf(" (howto 0x%x)", howto);
printf("\n");
}
if (exec_netbsd(filename, 0, howto, boot_biosdev < 0x80) < 0)
printf("boot: %s: %s\n", sprint_bootsel(filename),
strerror(errno));
else
printf("boot returned\n");
}
void
print_banner(void)
{
#ifndef SMALL
int n;
if (bootconf.banner[0]) {
for (n = 0; bootconf.banner[n] && n < MAXBANNER; n++)
printf("%s\n", bootconf.banner[n]);
} else {
#endif /* !SMALL */
printf("\n"
">> %s, Revision %s (from NetBSD %s)\n"
">> Memory: %d/%d k\n",
bootprog_name, bootprog_rev, bootprog_kernrev,
getbasemem(), getextmem());
#ifndef SMALL
}
#endif /* !SMALL */
}
#ifndef SMALL
int
atoi(const char *in)
{
char *c;
int ret;
ret = 0;
c = (char *)in;
if (*c == '-')
c++;
for (; isnum(*c); c++)
ret = (ret * 10) + (*c - '0');
return (*in == '-') ? -ret : ret;
}
/*
* This function parses a boot.cfg file in the root of the filesystem
* (if present) and populates the global boot configuration.
*
* The file consists of a number of lines each terminated by \n
* The lines are in the format keyword=value. There should not be spaces
* around the = sign.
*
* The recognised keywords are:
* banner: text displayed instead of the normal welcome text
* menu: Descriptive text:command to use
* timeout: Timeout in seconds (overrides that set by installboot)
* default: the default menu option to use if Return is pressed
* consdev: the console device to use
* format: how menu choices are displayed: (a)utomatic, (n)umbers or (l)etters
*
* Example boot.cfg file:
* banner=Welcome to NetBSD
* banner=Please choose the boot type from the following menu
* menu=Boot NetBSD:boot netbsd
* menu=Boot into single user mode:boot netbsd -s
* menu=:boot hd1a:netbsd -cs
* menu=Goto boot comand line:prompt
* timeout=10
* consdev=com0
* default=1
*/
void
parsebootconf(const char *conf)
{
char *bc, *c;
int cmenu, cbanner, len;
int fd, err, off;
struct stat st;
char *key, *value, *v2;
/* Clear bootconf structure */
bzero((void *)&bootconf, sizeof(bootconf));
/* Set timeout to configured */
bootconf.timeout = boot_params.bp_timeout;
/* automatically switch between letter and numbers on menu */
bootconf.menuformat = MENUFORMAT_AUTO;
fd = open(BOOTCONF, 0);
if (fd < 0)
return;
err = fstat(fd, &st);
if (err == -1) {
close(fd);
return;
}
bc = alloc(st.st_size + 1);
if (bc == NULL) {
printf("Could not allocate memory for boot configuration\n");
return;
}
off = 0;
do {
len = read(fd, bc + off, 1024);
if (len <= 0)
break;
off += len;
} while (len > 0);
bc[off] = '\0';
close(fd);
/* bc now contains the whole boot.cfg file */
cmenu = 0;
cbanner = 0;
for(c = bc; *c; c++) {
key = c;
/* Look for = separator between key and value */
for (; *c && *c != '='; c++)
continue;
if (*c == '\0')
break; /* break if at end of data */
/* zero terminate key which points to keyword */
*c++ = 0;
value = c;
/* Look for end of line (or file) and zero terminate value */
for (; *c && *c != '\n'; c++)
continue;
*c = 0;
if (!strncmp(key, "menu", 4)) {
/*
* Parse "menu=<description>:<command>". If the
* description is empty ("menu=:<command>)",
* then re-use the command as the description.
* Note that the command may contain embedded
* colons.
*/
if (cmenu >= MAXMENU)
continue;
bootconf.desc[cmenu] = value;
for (v2=value; *v2 && *v2 != ':'; v2++)
continue;
if (*v2) {
*v2++ = 0;
bootconf.command[cmenu] = v2;
if (! *value)
bootconf.desc[cmenu] = v2;
cmenu++;
} else {
/* No delimiter means invalid line */
bootconf.desc[cmenu] = NULL;
}
} else if (!strncmp(key, "banner", 6)) {
if (cbanner < MAXBANNER)
bootconf.banner[cbanner++] = value;
} else if (!strncmp(key, "timeout", 7)) {
if (!isnum(*value))
bootconf.timeout = -1;
else
bootconf.timeout = atoi(value);
} else if (!strncmp(key, "default", 7)) {
bootconf.def = atoi(value) - 1;
} else if (!strncmp(key, "consdev", 7)) {
bootconf.consdev = value;
} else if (!strncmp(key, "load", 4)) {
command_load(value);
} else if (!strncmp(key, "format", 6)) {
printf("value:%c\n", *value);
switch (*value) {
case 'a':
case 'A':
bootconf.menuformat = MENUFORMAT_AUTO;
break;
case 'n':
case 'N':
case 'd':
case 'D':
bootconf.menuformat = MENUFORMAT_NUMBER;
break;
case 'l':
case 'L':
bootconf.menuformat = MENUFORMAT_LETTER;
break;
}
}
}
switch (bootconf.menuformat) {
case MENUFORMAT_AUTO:
if (cmenu > 9 && bootconf.timeout > 0)
bootconf.menuformat = MENUFORMAT_LETTER;
else
bootconf.menuformat = MENUFORMAT_NUMBER;
break;
case MENUFORMAT_NUMBER:
if (cmenu > 9 && bootconf.timeout > 0)
cmenu = 9;
break;
}
bootconf.nummenu = cmenu;
if (bootconf.def < 0)
bootconf.def = 0;
if (bootconf.def >= cmenu)
bootconf.def = cmenu - 1;
}
/*
* doboottypemenu will render the menu and parse any user input
*/
static int getchoicefrominput(char *input, int def)
{
int choice;
choice = -1;
if (*input == '\0' || *input == '\r' || *input == '\n')
choice = def;
else if (*input >= 'A' && *input < bootconf.nummenu + 'A')
choice = (*input) - 'A';
else if (*input >= 'a' && *input < bootconf.nummenu + 'a')
choice = (*input) - 'a';
else if (isnum(*input)) {
choice = atoi(input) - 1;
if (choice < 0 || choice >= bootconf.nummenu)
choice = -1;
}
return choice;
}
void
doboottypemenu(void)
{
int choice;
char input[80], *ic, *oc;
printf("\n");
/* Display menu */
if (bootconf.menuformat == MENUFORMAT_LETTER) {
for (choice = 0; choice < bootconf.nummenu; choice++)
printf(" %c. %s\n", choice + 'A',
bootconf.desc[choice]);
} else {
/* Can't use %2d format string with libsa */
for (choice = 0; choice < bootconf.nummenu; choice++)
printf(" %s%d. %s\n",
(choice < 9) ? " " : "",
choice + 1,
bootconf.desc[choice]);
}
choice = -1;
for(;;) {
input[0] = '\0';
if (bootconf.timeout < 0) {
if (bootconf.menuformat == MENUFORMAT_LETTER)
printf("\nOption: [%c]:",
bootconf.def + 'A');
else
printf("\nOption: [%d]:",
bootconf.def + 1);
gets(input);
choice = getchoicefrominput(input, bootconf.def);
} else if (bootconf.timeout == 0)
choice = bootconf.def;
else {
printf("\nChoose an option; RETURN for default; "
"SPACE to stop countdown.\n");
if (bootconf.menuformat == MENUFORMAT_LETTER)
printf("Option %c will be chosen in ",
bootconf.def + 'A');
else
printf("Option %d will be chosen in ",
bootconf.def + 1);
input[0] = awaitkey(bootconf.timeout, 1);
input[1] = '\0';
choice = getchoicefrominput(input, bootconf.def);
/* If invalid key pressed, drop to menu */
if (choice == -1)
bootconf.timeout = -1;
}
if (choice < 0)
continue;
if (!strcmp(bootconf.command[choice], "prompt") &&
((boot_params.bp_flags & X86_BP_FLAGS_PASSWORD) == 0 ||
check_password(boot_params.bp_password))) {
printf("type \"?\" or \"help\" for help.\n");
bootmenu(); /* does not return */
} else {
ic = bootconf.command[choice];
/* Split command string at ; into separate commands */
do {
oc = input;
/* Look for ; separator */
for (; *ic && *ic != COMMAND_SEPARATOR; ic++)
*oc++ = *ic;
if (*input == '\0')
continue;
/* Strip out any trailing spaces */
oc--;
for (; *oc ==' ' && oc > input; oc--);
*++oc = '\0';
if (*ic == COMMAND_SEPARATOR)
ic++;
/* Stop silly command strings like ;;; */
if (*input != '\0')
docommand(input);
/* Skip leading spaces */
for (; *ic == ' '; ic++);
} while (*ic);
}
}
}
#endif /* !SMALL */
/*
* Called from the initial entry point boot_start in biosboot.S
*
* biosdev: BIOS drive number the system booted from
* biossector: Sector number of the NetBSD partition
*/
void
boot2(int biosdev, u_int biossector)
{
extern char twiddle_toggle;
int currname;
char c;
twiddle_toggle = 1; /* no twiddling until we're ready */
printf("\f"); /* clear screen (hopefully) */
initio(boot_params.bp_consdev);
#ifdef SUPPORT_PS2
biosmca();
#endif
gateA20();
if (boot_params.bp_flags & X86_BP_FLAGS_RESET_VIDEO)
biosvideomode();
/* need to remember these */
boot_biosdev = biosdev;
boot_biossector = biossector;
/* try to set default device to what BIOS tells us */
bios2dev(biosdev, biossector, &default_devname, &default_unit,
&default_partition);
/* if the user types "boot" without filename */
default_filename = DEFFILENAME;
#ifndef SMALL
parsebootconf(BOOTCONF);
/*
* If console set in boot.cfg, switch to it.
* This will print the banner, so we don't need to explicitly do it
*/
if (bootconf.consdev)
command_consdev(bootconf.consdev);
else
print_banner();
/* Display the menu, if applicable */
twiddle_toggle = 0;
if (bootconf.nummenu > 0) {
/* Does not return */
doboottypemenu();
}
#else
twiddle_toggle = 0;
print_banner();
#endif
printf("Press return to boot now, any other key for boot menu\n");
for (currname = 0; currname < NUMNAMES; currname++) {
printf("booting %s - starting in ",
sprint_bootsel(names[currname][0]));
#ifdef SMALL
c = awaitkey(boot_params.bp_timeout, 1);
#else
c = awaitkey((bootconf.timeout < 0) ? 0 : bootconf.timeout, 1);
#endif
if ((c != '\r') && (c != '\n') && (c != '\0') &&
((boot_params.bp_flags & X86_BP_FLAGS_PASSWORD) == 0
|| check_password(boot_params.bp_password))) {
printf("type \"?\" or \"help\" for help.\n");
bootmenu(); /* does not return */
}
/*
* try pairs of names[] entries, foo and foo.gz
*/
/* don't print "booting..." again */
bootit(names[currname][0], 0, 0);
/* since it failed, try compressed bootfile. */
bootit(names[currname][1], 0, 1);
}
bootmenu(); /* does not return */
}
/* ARGSUSED */
void
command_help(char *arg)
{
printf("commands are:\n"
"boot [xdNx:][filename] [-12acdqsvxz]\n"
" (ex. \"hd0a:netbsd.old -s\"\n"
"ls [path]\n"
"dev xd[N[x]]:\n"
"consdev {pc|com[0123]|com[0123]kbd|auto}\n"
"modules {enabled|disabled}\n"
"load {path_to_module}\n"
"multiboot [xdNx:][filename] [<args>]\n"
"help|?\n"
"quit\n");
}
void
command_ls(char *arg)
{
const char *save = default_filename;
default_filename = "/";
ufs_ls(arg);
default_filename = save;
}
/* ARGSUSED */
void
command_quit(char *arg)
{
printf("Exiting...\n");
delay(1000000);
reboot();
/* Note: we shouldn't get to this point! */
panic("Could not reboot!");
exit(0);
}
void
command_boot(char *arg)
{
char *filename;
int howto;
if (parseboot(arg, &filename, &howto))
bootit(filename, howto, 1);
}
void
command_dev(char *arg)
{
static char savedevname[MAXDEVNAME + 1];
char *fsname, *devname;
const char *file; /* dummy */
if (*arg == '\0') {
printf("%s%d%c:\n", default_devname, default_unit,
'a' + default_partition);
return;
}
if (strchr(arg, ':') == NULL ||
parsebootfile(arg, &fsname, &devname, &default_unit,
&default_partition, &file)) {
command_help(NULL);
return;
}
/* put to own static storage */
strncpy(savedevname, devname, MAXDEVNAME + 1);
default_devname = savedevname;
}
static const struct cons_devs {
const char *name;
u_int tag;
} cons_devs[] = {
{ "pc", CONSDEV_PC },
{ "com0", CONSDEV_COM0 },
{ "com1", CONSDEV_COM1 },
{ "com2", CONSDEV_COM2 },
{ "com3", CONSDEV_COM3 },
{ "com0kbd", CONSDEV_COM0KBD },
{ "com1kbd", CONSDEV_COM1KBD },
{ "com2kbd", CONSDEV_COM2KBD },
{ "com3kbd", CONSDEV_COM3KBD },
{ "auto", CONSDEV_AUTO },
{ NULL, 0 }
};
void
command_consdev(char *arg)
{
const struct cons_devs *cdp;
for (cdp = cons_devs; cdp->name; cdp++) {
if (strcmp(arg, cdp->name) == 0) {
initio(cdp->tag);
print_banner();
return;
}
}
printf("invalid console device.\n");
}
void
command_modules(char *arg)
{
if (strcmp(arg, "enabled") == 0 ||
strcmp(arg, "on") == 0)
boot_modules_enabled = true;
else if (strcmp(arg, "disabled") == 0 ||
strcmp(arg, "off") == 0)
boot_modules_enabled = false;
else
printf("invalid flag, must be 'enabled' or 'disabled'.\n");
}
void
command_load(char *arg)
{
boot_module_t *bm, *bmp;
size_t len;
char *str;
while (*arg == ' ' || *arg == '\t')
++arg;
bm = alloc(sizeof(boot_module_t));
len = strlen(arg) + 1;
str = alloc(len);
if (bm == NULL || str == NULL) {
printf("couldn't allocate module\n");
return;
}
memcpy(str, arg, len);
bm->bm_path = str;
bm->bm_next = NULL;
if (boot_modules == NULL)
boot_modules = bm;
else {
for (bmp = boot_modules; bmp->bm_next;
bmp = bmp->bm_next)
;
bmp->bm_next = bm;
}
}
void
command_multiboot(char *arg)
{
char *filename;
filename = arg;
if (exec_multiboot(filename, gettrailer(arg)) < 0)
printf("multiboot: %s: %s\n", sprint_bootsel(filename),
strerror(errno));
else
printf("boot returned\n");
}