2 * Copyright (c) 2003,2004 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Copyright (c) 1998 Robert Nordier
35 * All rights reserved.
37 * Redistribution and use in source and binary forms are freely
38 * permitted provided that the above copyright notice and this
39 * paragraph and the following disclaimer are duplicated in all
42 * This software is provided "AS IS" and without any express or
43 * implied warranties, including, without limitation, the implied
44 * warranties of merchantability and fitness for a particular
47 * $FreeBSD: src/sys/boot/i386/boot2/boot2.c,v 1.64 2003/08/25 23:28:31 obrien Exp $
50 #define AOUT_H_FORCE32
51 #include <sys/param.h>
53 #include <sys/disklabel64.h>
55 #include <sys/disklabel32.h>
57 #include <sys/diskslice.h>
58 #include <sys/diskmbr.h>
59 #include <sys/dtype.h>
60 #include <sys/dirent.h>
61 #include <machine/bootinfo.h>
62 #include <machine/elf.h>
63 #include <machine/psl.h>
78 #include "../bootasm.h"
80 #define SECOND 18 /* Circa that many ticks in a second. */
82 #define RBX_ASKNAME 0x0 /* -a */
83 #define RBX_SINGLE 0x1 /* -s */
84 #define RBX_DFLTROOT 0x5 /* -r */
85 #define RBX_KDB 0x6 /* -d */
86 #define RBX_CONFIG 0xa /* -c */
87 #define RBX_VERBOSE 0xb /* -v */
88 #define RBX_SERIAL 0xc /* -h */
89 #define RBX_CDROM 0xd /* -C */
90 #define RBX_GDB 0xf /* -g */
91 #define RBX_MUTE 0x10 /* -m */
92 #define RBX_PAUSE 0x12 /* -p */
93 #define RBX_NOINTR 0x1c /* -n */
94 #define RBX_VIDEO 0x1d /* -V */
95 #define RBX_PROBEKBD 0x1e /* -P */
96 /* 0x1f is reserved for the historical RB_BOOTINFO option */
98 #define RBF_MUTE (1 << RBX_MUTE)
99 #define RBF_SERIAL (1 << RBX_SERIAL)
100 #define RBF_VIDEO (1 << RBX_VIDEO)
101 #define RBF_NOINTR (1 << RBX_NOINTR)
102 #define RBF_PROBEKBD (1 << RBX_PROBEKBD)
104 /* pass: -a, -s, -r, -d, -c, -v, -h, -C, -g, -m, -p, -V */
105 #define RBX_MASK 0x2005ffff
107 #define PATH_CONFIG "/boot.config"
108 #define PATH_BOOT3 "/loader" /* /boot is dedicated */
109 #define PATH_BOOT3_ALT "/boot/loader" /* /boot in root */
110 #define PATH_KERNEL "/kernel"
114 #define MEM_BASE 0x12
116 #define V86_CY(x) ((x) & PSL_C)
117 #define V86_ZR(x) ((x) & PSL_Z)
119 #define DRV_HARD 0x80
120 #define DRV_MASK 0x7f
124 #define TYPE_MAXHARD TYPE_DA
127 #define INVALID_S "Bad %s\n"
129 extern uint32_t _end;
131 static const char optstr[NOPT] = { "VhaCgmnPprsv" };
132 static const unsigned char flags[NOPT] = {
147 static const char *const dev_nm[NDEV] = {"ad", "da", "fd"};
148 static const unsigned char dev_maj[NDEV] = {30, 4, 2};
160 static char cmd[512];
161 static const char *kname;
162 static uint32_t opts = RBF_VIDEO;
163 static struct bootinfo bootinfo;
166 * boot2 encapsulated ABI elements provided to *fsread.c
168 * NOTE: boot2_dmadat is extended by per-filesystem APIs
173 struct boot2_dmadat *boot2_dmadat;
176 static void load(void);
177 static int parse(void);
178 static int dskprobe(void);
179 static int xfsread(boot2_ino_t, void *, size_t);
180 static int drvread(void *, unsigned, unsigned);
181 static int keyhit(unsigned);
182 static int xputc(int);
183 static int xgetc(int);
184 static int getc(int);
187 memcpy(void *d, const void *s, int len)
197 strcmp(const char *s1, const char *s2)
199 for (; *s1 == *s2 && *s1; s1++, s2++)
201 return ((int)((unsigned char)*s1 - (unsigned char)*s2));
204 #if defined(UFS) && defined(HAMMER2FS)
206 const struct boot2_fsapi *fsapi;
210 #define fsapi (&boot2_ufs_api)
212 #elif defined(HAMMER2FS)
214 #define fsapi (&boot2_hammer2_api)
219 xfsread(boot2_ino_t inode, void *buf, size_t nbyte)
221 if ((size_t)fsapi->fsread(inode, buf, nbyte) != nbyte) {
222 printf(INVALID_S, "format");
236 switch (c = xgetc(0)) {
251 if (s - cmd < sizeof(cmd) - 1)
262 v86.eax = 0xe00 | (c & 0xff);
275 (void *)(roundup2(__base + (int32_t)&_end, 0x10000) - __base);
277 v86.efl = PSL_RESERVED_DEFAULT | PSL_I;
278 dsk.drive = *(uint8_t *)PTOV(MEM_BTX_USR_ARG);
279 dsk.type = dsk.drive & DRV_HARD ? TYPE_AD : TYPE_FD;
280 dsk.unit = dsk.drive & DRV_MASK;
281 dsk.slice = *(uint8_t *)PTOV(MEM_BTX_USR_ARG + 1) + 1;
282 bootinfo.bi_version = BOOTINFO_VERSION;
283 bootinfo.bi_size = sizeof(bootinfo);
288 * Probe the default disk and process the configuration file if
291 if (dskprobe() == 0) {
292 if ((ino = fsapi->fslookup(PATH_CONFIG)))
293 fsapi->fsread(ino, cmd, sizeof(cmd));
297 * Parse config file if present. parse() will re-probe if necessary.
300 printf("%s: %s", PATH_CONFIG, cmd);
303 /* Do not process this command twice */
308 * Setup our (serial) console after processing the config file. If
309 * the initialization fails, don't try to use the serial port. This
310 * can happen if the serial port is unmaped (happens on new laptops a lot).
312 if ((opts & (RBF_MUTE|RBF_SERIAL|RBF_VIDEO)) == 0)
313 opts |= RBF_SERIAL|RBF_VIDEO;
314 if (opts & RBF_SERIAL) {
321 * Try to exec stage 3 boot loader. If interrupted by a keypress,
322 * or in case of failure, try to load a kernel directly instead.
324 * We have to try boot /boot/loader and /loader to support booting
325 * from a /boot partition instead of a root partition.
327 if (autoboot && !kname) {
329 if (!keyhit(3*SECOND)) {
331 kname = PATH_BOOT3_ALT;
337 /* Present the user with the boot2 prompt. */
340 printf("\nDragonFly boot\n"
342 dsk.drive & DRV_MASK, dev_nm[dsk.type], dsk.unit,
343 'a' + dsk.part, kname);
344 if (!autoboot || keyhit(5*SECOND))
356 /* XXX - Needed for btxld to link the boot2 binary; do not remove. */
369 static Elf32_Phdr ep[2];
370 static Elf32_Shdr es[2];
376 if (!(ino = fsapi->fslookup(kname))) {
378 printf("No %s\n", kname);
381 if (xfsread(ino, &hdr, sizeof(hdr)))
384 if (N_GETMAGIC(hdr.ex) == ZMAGIC) {
385 addr = hdr.ex.a_entry & 0xffffff;
388 if (xfsread(ino, p, hdr.ex.a_text))
390 p += roundup2(hdr.ex.a_text, PAGE_SIZE);
391 if (xfsread(ino, p, hdr.ex.a_data))
393 } else if (IS_ELF(hdr.eh)) {
394 fs_off = hdr.eh.e_phoff;
395 for (j = i = 0; i < hdr.eh.e_phnum && j < 2; i++) {
396 if (xfsread(ino, ep + j, sizeof(ep[0])))
398 if (ep[j].p_type == PT_LOAD)
401 for (i = 0; i < 2; i++) {
402 p = PTOV(ep[i].p_paddr & 0xffffff);
403 fs_off = ep[i].p_offset;
404 if (xfsread(ino, p, ep[i].p_filesz))
407 p += roundup2(ep[1].p_memsz, PAGE_SIZE);
408 bootinfo.bi_symtab = VTOP(p);
409 if (hdr.eh.e_shnum == hdr.eh.e_shstrndx + 3) {
410 fs_off = hdr.eh.e_shoff + sizeof(es[0]) *
411 (hdr.eh.e_shstrndx + 1);
412 if (xfsread(ino, &es, sizeof(es)))
414 for (i = 0; i < 2; i++) {
415 *(Elf32_Word *)p = es[i].sh_size;
416 p += sizeof(es[i].sh_size);
417 fs_off = es[i].sh_offset;
418 if (xfsread(ino, p, es[i].sh_size))
423 addr = hdr.eh.e_entry & 0xffffff;
424 bootinfo.bi_esymtab = VTOP(p);
426 printf(INVALID_S, "format");
430 bootinfo.bi_kernelname = VTOP(kname);
431 bootinfo.bi_bios_dev = dsk.drive;
432 __exec((caddr_t)addr, opts & RBX_MASK,
433 MAKEBOOTDEV(dev_maj[dsk.type], 0, dsk.slice, dsk.unit, dsk.part),
434 0, 0, 0, VTOP(&bootinfo));
445 while ((c = *arg++)) {
446 if (c == ' ' || c == '\t' || c == '\n')
448 for (p = arg; *p && *p != '\n' && *p != ' ' && *p != '\t'; p++)
453 while ((c = *arg++)) {
454 for (i = NOPT - 1; i >= 0; --i) {
455 if (optstr[i] == c) {
456 opts ^= 1 << flags[i];
461 ok: ; /* ugly but save space */
463 if (opts & RBF_PROBEKBD) {
464 i = *(uint8_t *)PTOV(0x496) & 0x10;
467 opts |= RBF_VIDEO | RBF_SERIAL;
469 opts &= ~RBF_PROBEKBD;
472 for (q = arg--; *q && *q != '('; q++);
483 for (i = 0; arg[0] != dev_nm[i][0] ||
484 arg[1] != dev_nm[i][1]; i++)
489 dsk.unit = *arg - '0';
490 if (arg[1] != ',' || dsk.unit > 9)
493 dsk.slice = WHOLE_DISK_SLICE;
495 dsk.slice = *arg - '0' + 1;
496 if (dsk.slice > NDOSPART + 1)
502 dsk.part = *arg - 'a';
508 dsk.drive = (dsk.type <= TYPE_MAXHARD
509 ? DRV_HARD : 0) + drv;
521 struct dos_partition *dp;
523 struct disklabel64 *d;
525 struct disklabel32 *d;
534 sec = boot2_dmadat->secbuf;
536 if (drvread(sec, DOSBBSECTOR, 1))
538 dp = (void *)(sec + DOSPARTOFF);
540 if (sl < BASE_SLICE) {
541 for (i = 0; i < NDOSPART; i++)
542 if (dp[i].dp_typ == DOSPTYP_386BSD &&
543 (dp[i].dp_flag & 0x80 || sl < BASE_SLICE)) {
545 if (dp[i].dp_flag & 0x80 ||
546 dsk.slice == COMPATIBILITY_SLICE)
549 if (dsk.slice == WHOLE_DISK_SLICE)
552 if (sl != WHOLE_DISK_SLICE) {
553 if (sl != COMPATIBILITY_SLICE)
554 dp += sl - BASE_SLICE;
555 if (dp->dp_typ != DOSPTYP_386BSD) {
556 printf(INVALID_S, "slice");
559 dsk.start = dp->dp_start;
563 * Probe label and partition table
566 if (drvread(sec, dsk.start, (sizeof(struct disklabel64) + 511) / 512))
569 if (d->d_magic != DISKMAGIC64) {
570 printf(INVALID_S, "label");
573 if (dsk.part >= d->d_npartitions || d->d_partitions[dsk.part].p_bsize == 0) {
574 printf(INVALID_S, "partition");
577 dsk.start += d->d_partitions[dsk.part].p_boffset / 512;
580 if (drvread(sec, dsk.start + LABELSECTOR32, 1))
582 d = (void *)(sec + LABELOFFSET32);
583 if (d->d_magic != DISKMAGIC32 || d->d_magic2 != DISKMAGIC32) {
584 if (dsk.part != RAW_PART) {
585 printf(INVALID_S, "label");
590 if (d->d_type == DTYPE_SCSI)
594 if (dsk.part >= d->d_npartitions ||
595 !d->d_partitions[dsk.part].p_size) {
596 printf(INVALID_S, "partition");
599 dsk.start += d->d_partitions[dsk.part].p_offset;
600 dsk.start -= d->d_partitions[RAW_PART].p_offset;
606 #if defined(UFS) && defined(HAMMER2FS)
607 if (boot2_ufs_api.fsinit() == 0) {
608 fsapi = &boot2_ufs_api;
609 } else if (boot2_hammer2_api.fsinit() == 0) {
610 fsapi = &boot2_hammer2_api;
612 printf("fs probe failed\n");
613 fsapi = &boot2_ufs_api;
618 return fsapi->fsinit();
624 * Read from the probed disk. We have established the slice and partition
628 dskread(void *buf, unsigned lba, unsigned nblk)
630 return drvread(buf, dsk.start + lba, nblk);
634 * boot encapsulated ABI
637 printf(const char *fmt,...)
649 while ((c = *fmt++)) {
654 putchar(va_arg(ap, int));
657 for (s = va_arg(ap, char *); *s; s++)
662 ++fmt; /* skip the 'x' */
663 q = va_arg(ap, uint64_t);
667 *s++ = '0' + (q & 15);
669 *s++ = 'a' + (q & 15) - 10;
675 u = va_arg(ap, unsigned);
679 *s++ = '0' + (u & 15);
681 *s++ = 'a' + (u & 15) - 10;
688 u = va_arg(ap, unsigned);
691 *s++ = '0' + u % 10U;
705 * boot encapsulated ABI
716 * boot encapsulated ABI
719 drvread(void *buf, unsigned lba, unsigned nblk)
721 static unsigned c = 0x2d5c7c2f; /* twiddle */
723 c = (c << 8) | (c >> 24);
726 v86.ctl = V86_ADDR | V86_CALLF | V86_FLAGS;
727 v86.addr = XREADORG; /* call to xread in boot1 */
728 v86.es = VTOPSEG(buf);
730 v86.ebx = VTOPOFF(buf);
732 v86.edx = nblk << 8 | dsk.drive;
735 if (V86_CY(v86.efl) && !no_io_error) {
736 printf("error %u lba %u\n", v86.eax >> 8 & 0xff, lba);
743 keyhit(unsigned ticks)
747 if (opts & RBF_NOINTR)
753 t1 = *(uint32_t *)PTOV(0x46c);
756 if ((uint32_t)(t1 - t0) >= ticks)
764 if (opts & RBF_VIDEO)
766 if (opts & RBF_SERIAL)
777 return fn == 0 ? v86.eax & 0xff : !V86_ZR(v86.efl);
783 if (opts & RBF_NOINTR)
786 if ((opts & RBF_VIDEO) && getc(1))
787 return fn ? 1 : getc(0);
788 if ((opts & RBF_SERIAL) && sio_ischar())
789 return fn ? 1 : sio_getc();