stand/mips/beri/boot2/boot2.c

   1 /*-
   2  * Copyright (c) 2013-2014 Robert N. M. Watson
   3  * All rights reserved.
   4  *
   5  * This software was developed by SRI International and the University of
   6  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
   7  * ("CTSRD"), as part of the DARPA CRASH research programme.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28  * SUCH DAMAGE.
  29  *
  30  * Copyright (c) 1998 Robert Nordier
  31  * All rights reserved.
  32  *
  33  * Redistribution and use in source and binary forms are freely
  34  * permitted provided that the above copyright notice and this
  35  * paragraph and the following disclaimer are duplicated in all
  36  * such forms.
  37  *
  38  * This software is provided "AS IS" and without any express or
  39  * implied warranties, including, without limitation, the implied
  40  * warranties of merchantability and fitness for a particular
  41  * purpose.
  42  */
  43
  44 #include <sys/cdefs.h>
  45 __FBSDID("$FreeBSD$");
  46
  47 #include <sys/param.h>
  48 #include <sys/disklabel.h>
  49 #include <sys/diskmbr.h>
  50 #include <sys/dirent.h>
  51 #include <sys/endian.h>
  52 #include <sys/reboot.h>
  53
  54 #include <machine/bootinfo.h>
  55 #include <machine/elf.h>
  56
  57 #include <stand.h>
  58 #include <stdarg.h>
  59 #include <string.h>
  60
  61 #include <beri.h>
  62 #include <cfi.h>
  63 #include <cons.h>
  64 #include <mips.h>
  65 #include <sdcard.h>
  66
  67 #include "paths.h"
  68 #include "rbx.h"
  69
  70 static int               beri_argc;
  71 static const char       **beri_argv, **beri_envv;
  72 static uint64_t          beri_memsize;
  73
  74 #define IO_KEYBOARD     1
  75 #define IO_SERIAL       2
  76
  77 #define SECOND          1       /* Circa that many ticks in a second. */
  78
  79 #define ARGS            0x900
  80 #define NOPT            14
  81 #define MEM_BASE        0x12
  82 #define MEM_EXT         0x15
  83
  84 /*
  85  * XXXRW: I think this has to do with whether boot2 expects a partition
  86  * table?
  87  */
  88 #define DRV_HARD        0x80
  89 #define DRV_MASK        0x7f
  90
  91 /* Default to using CFI flash. */
  92 #define TYPE_DEFAULT    BOOTINFO_DEV_TYPE_SDCARD
  93
  94 /* Hard-coded assumption about location of JTAG-loaded kernel. */
  95 #define DRAM_KERNEL_ADDR        ((void *)mips_phys_to_cached(0x20000))
  96
  97 extern uint32_t _end;
  98
  99 static const char optstr[NOPT] = "DhaCcdgmnpqrsv"; /* Also 'P', 'S' */
 100 static const unsigned char flags[NOPT] = {
 101     RBX_DUAL,
 102     RBX_SERIAL,
 103     RBX_ASKNAME,
 104     RBX_CDROM,
 105     RBX_CONFIG,
 106     RBX_KDB,
 107     RBX_GDB,
 108     RBX_MUTE,
 109     RBX_NOINTR,
 110     RBX_PAUSE,
 111     RBX_QUIET,
 112     RBX_DFLTROOT,
 113     RBX_SINGLE,
 114     RBX_VERBOSE
 115 };
 116
 117 /* These must match BOOTINFO_DEV_TYPE constants. */
 118 static const char *const dev_nm[] = {"dram", "cfi", "sdcard"};
 119 static const u_int dev_nm_count = nitems(dev_nm);
 120
 121 static struct dsk {
 122     unsigned type;              /* BOOTINFO_DEV_TYPE_x object type. */
 123     uintptr_t unitptr;          /* Unit number or pointer to object. */
 124     uint8_t slice;
 125     uint8_t part;
 126 #if 0
 127     unsigned start;
 128     int init;
 129 #endif
 130 } dsk;
 131 static char cmd[512], cmddup[512], knamebuf[1024];
 132 static const char *kname;
 133 uint32_t opts;
 134 #if 0
 135 static int comspeed = SIOSPD;
 136 #endif
 137 struct bootinfo bootinfo;
 138 static uint8_t ioctrl = IO_KEYBOARD;
 139
 140 void exit(int);
 141 void putchar(int);
 142 static void boot_fromdram(void);
 143 static void boot_fromfs(void);
 144 static void load(void);
 145 static int parse(void);
 146 static int dskread(void *, unsigned, unsigned);
 147 static int xputc(int);
 148 static int xgetc(int);
 149
 150 #define UFS_SMALL_CGBASE
 151 #include "ufsread.c"
 152
 153 static struct dmadat __dmadat;
 154
 155 static inline int
 156 xfsread(ufs_ino_t inode, void *buf, size_t nbyte)
 157 {
 158     if ((size_t)fsread(inode, buf, nbyte) != nbyte) {
 159         printf("Invalid %s\n", "format");
 160         return -1;
 161     }
 162     return 0;
 163 }
 164
 165 static inline void
 166 getstr(void)
 167 {
 168     char *s;
 169     int c;
 170
 171     s = cmd;
 172     for (;;) {
 173         switch (c = xgetc(0)) {
 174         case 0:
 175             break;
 176         case '\177':
 177         case '\b':
 178             if (s > cmd) {
 179                 s--;
 180                 printf("\b \b");
 181             }
 182             break;
 183         case '\n':
 184         case '\r':
 185                 putchar('\n');
 186             *s = 0;
 187             return;
 188         default:
 189             if (s - cmd < sizeof(cmd) - 1)
 190                 *s++ = c;
 191             putchar(c);
 192         }
 193     }
 194 }
 195
 196 int
 197 main(u_int argc, const char *argv[], const char *envv[], uint64_t memsize)
 198 {
 199     uint8_t autoboot;
 200     ufs_ino_t ino;
 201     size_t nbyte;
 202
 203     /* Arguments from Miniboot. */
 204     beri_argc = argc;
 205     beri_argv = argv;
 206     beri_envv = envv;
 207     beri_memsize = memsize;
 208
 209     dmadat = &__dmadat;
 210 #if 0
 211     /* XXXRW: more here. */
 212     v86.ctl = V86_FLAGS;
 213     v86.efl = PSL_RESERVED_DEFAULT | PSL_I;
 214     dsk.drive = *(uint8_t *)PTOV(ARGS);
 215 #endif
 216     dsk.type = TYPE_DEFAULT;
 217 #if 0
 218     dsk.unit = dsk.drive & DRV_MASK;
 219     dsk.slice = *(uint8_t *)PTOV(ARGS + 1) + 1;
 220 #endif
 221     bootinfo.bi_version = BOOTINFO_VERSION;
 222     bootinfo.bi_size = sizeof(bootinfo);
 223
 224     /* Process configuration file */
 225
 226     autoboot = 1;
 227
 228     if ((ino = lookup(PATH_CONFIG)) ||
 229         (ino = lookup(PATH_DOTCONFIG))) {
 230         nbyte = fsread(ino, cmd, sizeof(cmd) - 1);
 231         cmd[nbyte] = '\0';
 232     }
 233
 234     if (*cmd) {
 235         memcpy(cmddup, cmd, sizeof(cmd));
 236         if (parse())
 237             autoboot = 0;
 238         if (!OPT_CHECK(RBX_QUIET))
 239             printf("%s: %s", PATH_CONFIG, cmddup);
 240         /* Do not process this command twice */
 241         *cmd = 0;
 242     }
 243
 244     /*
 245      * Try to exec stage 3 boot loader. If interrupted by a keypress,
 246      * or in case of failure, try to load a kernel directly instead.
 247      */
 248
 249     if (!kname) {
 250         kname = PATH_LOADER;
 251         if (autoboot && !keyhit(3*SECOND)) {
 252             boot_fromfs();
 253             kname = PATH_KERNEL;
 254         }
 255     }
 256
 257     /* Present the user with the boot2 prompt. */
 258
 259     for (;;) {
 260         if (!autoboot || !OPT_CHECK(RBX_QUIET))
 261             printf("\nFreeBSD/mips boot\n"
 262                    "Default: %s%ju:%s\n"
 263                    "boot: ",
 264                    dev_nm[dsk.type], dsk.unitptr, kname);
 265 #if 0
 266         if (ioctrl & IO_SERIAL)
 267             sio_flush();
 268 #endif
 269         if (!autoboot || keyhit(3*SECOND))
 270             getstr();
 271         else if (!autoboot || !OPT_CHECK(RBX_QUIET))
 272             putchar('\n');
 273         autoboot = 0;
 274         if (parse())
 275             putchar('\a');
 276         else
 277             load();
 278     }
 279 }
 280
 281 /* XXX - Needed for btxld to link the boot2 binary; do not remove. */
 282 void
 283 exit(int x)
 284 {
 285 }
 286
 287 static void
 288 boot(void *entryp, int argc, const char *argv[], const char *envv[])
 289 {
 290
 291     bootinfo.bi_kernelname = (bi_ptr_t)kname;
 292     bootinfo.bi_boot2opts = opts & RBX_MASK;
 293     bootinfo.bi_boot_dev_type = dsk.type;
 294     bootinfo.bi_boot_dev_unitptr = dsk.unitptr;
 295     bootinfo.bi_memsize = beri_memsize;
 296 #if 0
 297     /*
 298      * XXXRW: A possible future way to distinguish Miniboot passing a memory
 299      * size vs DTB..?
 300      */
 301     if (beri_memsize <= BERI_MEMVSDTB)
 302         bootinfo.bi_memsize = beri_memsize;
 303     else
 304         bootinfo.bi_dtb = beri_memsize;
 305 #endif
 306     ((void(*)(int, const char **, const char **, void *))entryp)(argc, argv,
 307       envv, &bootinfo);
 308 }
 309
 310 /*
 311  * Boot a kernel that has mysteriously (i.e., by JTAG) appeared in DRAM;
 312  * assume that it is already properly relocated, etc, and invoke its entry
 313  * address without question or concern.
 314  */
 315 static void
 316 boot_fromdram(void)
 317 {
 318     void *kaddr = DRAM_KERNEL_ADDR;     /* XXXRW: Something better here. */
 319     Elf64_Ehdr *ehp = kaddr;
 320
 321     if (!IS_ELF(*ehp)) {
 322         printf("Invalid %s\n", "format");
 323         return;
 324     }
 325     boot((void *)ehp->e_entry, beri_argc, beri_argv, beri_envv);
 326 }
 327
 328 static void
 329 boot_fromfs(void)
 330 {
 331     union {
 332         Elf64_Ehdr eh;
 333     } hdr;
 334     static Elf64_Phdr ep[2];
 335 #if 0
 336     static Elf64_Shdr es[2];
 337 #endif
 338     caddr_t p;
 339     ufs_ino_t ino;
 340     uint64_t addr;
 341     int i, j;
 342
 343     if (!(ino = lookup(kname))) {
 344         if (!ls)
 345             printf("No %s\n", kname);
 346         return;
 347     }
 348     if (xfsread(ino, &hdr, sizeof(hdr)))
 349         return;
 350
 351     if (IS_ELF(hdr.eh)) {
 352         fs_off = hdr.eh.e_phoff;
 353         for (j = i = 0; i < hdr.eh.e_phnum && j < 2; i++) {
 354             if (xfsread(ino, ep + j, sizeof(ep[0])))
 355                 return;
 356             if (ep[j].p_type == PT_LOAD)
 357                 j++;
 358         }
 359         for (i = 0; i < 2; i++) {
 360             p = (caddr_t)ep[i].p_paddr;
 361             fs_off = ep[i].p_offset;
 362             if (xfsread(ino, p, ep[i].p_filesz))
 363                 return;
 364         }
 365         p += roundup2(ep[1].p_memsz, PAGE_SIZE);
 366 #if 0
 367         bootinfo.bi_symtab = VTOP(p);
 368         if (hdr.eh.e_shnum == hdr.eh.e_shstrndx + 3) {
 369             fs_off = hdr.eh.e_shoff + sizeof(es[0]) *
 370                 (hdr.eh.e_shstrndx + 1);
 371             if (xfsread(ino, &es, sizeof(es)))
 372                 return;
 373             for (i = 0; i < 2; i++) {
 374                 *(Elf32_Word *)p = es[i].sh_size;
 375                 p += sizeof(es[i].sh_size);
 376                 fs_off = es[i].sh_offset;
 377                 if (xfsread(ino, p, es[i].sh_size))
 378                     return;
 379                 p += es[i].sh_size;
 380             }
 381         }
 382 #endif
 383         addr = hdr.eh.e_entry;
 384 #if 0
 385         bootinfo.bi_esymtab = VTOP(p);
 386 #endif
 387     } else {
 388         printf("Invalid %s\n", "format");
 389         return;
 390     }
 391     boot((void *)addr, beri_argc, beri_argv, beri_envv);
 392 }
 393
 394 static void
 395 load(void)
 396 {
 397
 398         switch (dsk.type) {
 399         case BOOTINFO_DEV_TYPE_DRAM:
 400                 boot_fromdram();
 401                 break;
 402
 403         default:
 404                 boot_fromfs();
 405                 break;
 406         }
 407 }
 408
 409 static int
 410 parse()
 411 {
 412     char *arg = cmd;
 413     char *ep, *p, *q;
 414     char unit;
 415     size_t len;
 416     const char *cp;
 417 #if 0
 418     int c, i, j;
 419 #else
 420     int c, i;
 421 #endif
 422
 423     while ((c = *arg++)) {
 424         if (c == ' ' || c == '\t' || c == '\n')
 425             continue;
 426         for (p = arg; *p && *p != '\n' && *p != ' ' && *p != '\t'; p++);
 427         ep = p;
 428         if (*p)
 429             *p++ = 0;
 430         if (c == '-') {
 431             while ((c = *arg++)) {
 432                 if (c == 'P') {
 433                         cp = "yes";
 434 #if 0
 435                     } else {
 436                         opts |= OPT_SET(RBX_DUAL) | OPT_SET(RBX_SERIAL);
 437                         cp = "no";
 438                     }
 439 #endif
 440                     printf("Keyboard: %s\n", cp);
 441                     continue;
 442 #if 0
 443                 } else if (c == 'S') {
 444                     j = 0;
 445                     while ((unsigned int)(i = *arg++ - '0') <= 9)
 446                         j = j * 10 + i;
 447                     if (j > 0 && i == -'0') {
 448                         comspeed = j;
 449                         break;
 450                     }
 451                     /* Fall through to error below ('S' not in optstr[]). */
 452 #endif
 453                 }
 454                 for (i = 0; c != optstr[i]; i++)
 455                     if (i == NOPT - 1)
 456                         return -1;
 457                 opts ^= OPT_SET(flags[i]);
 458             }
 459             ioctrl = OPT_CHECK(RBX_DUAL) ? (IO_SERIAL|IO_KEYBOARD) :
 460                      OPT_CHECK(RBX_SERIAL) ? IO_SERIAL : IO_KEYBOARD;
 461 #if 0
 462             if (ioctrl & IO_SERIAL) {
 463                 if (sio_init(115200 / comspeed) != 0)
 464                     ioctrl &= ~IO_SERIAL;
 465             }
 466 #endif
 467         } else {
 468             /*-
 469              * Parse a device/kernel name.  Format(s):
 470              *
 471              *   path
 472              *   deviceX:path
 473              *
 474              * NB: Utterly incomprehensible but space-efficient ARM/i386
 475              * parsing removed in favour of larger but easier-to-read C.  This
 476              * is still not great, however -- e.g., relating to unit handling.
 477              *
 478              * TODO: it would be nice if a DRAM pointer could be specified
 479              * here.
 480              *
 481              * XXXRW: Pick up pieces here.
 482              */
 483
 484             /*
 485              * Search for a parens; if none, then it's just a path.
 486              * Otherwise, it's a devicename.
 487              */
 488             arg--;
 489             q = strsep(&arg, ":");
 490             if (arg != NULL) {
 491                 len = strlen(q);
 492                 if (len < 2) {
 493                     printf("Invalid device: name too short\n");
 494                     return (-1);
 495                 }
 496
 497                 /*
 498                  * First, handle one-digit unit.
 499                  */
 500                 unit = q[len-1];
 501                 if (unit < '0' || unit > '9') {
 502                     printf("Invalid device: invalid unit %c\n",
 503                       unit);
 504                     return (-1);
 505                 }
 506                 unit -= '0';
 507                 q[len-1] = '\0';
 508
 509                 /*
 510                  * Next, find matching device.
 511                  */
 512                 for (i = 0; i < dev_nm_count; i++) {
 513                     if (strcmp(q, dev_nm[i]) == 0)
 514                         break;
 515                 }
 516                 if (i == dev_nm_count) {
 517                     printf("Invalid device: no driver match\n");
 518                     return (-1);
 519                 }
 520                 dsk.type = i;
 521                 dsk.unitptr = unit;     /* Someday: also a DRAM pointer? */
 522             } else
 523                 arg = q;
 524             if ((i = ep - arg)) {
 525                 if ((size_t)i >= sizeof(knamebuf))
 526                     return -1;
 527                 memcpy(knamebuf, arg, i + 1);
 528                 kname = knamebuf;
 529             }
 530         }
 531         arg = p;
 532     }
 533     return 0;
 534 }
 535
 536 static int
 537 drvread(void *buf, unsigned lba, unsigned nblk)
 538 {
 539
 540         /* XXXRW: eventually, we may want to pass 'drive' and 'unit' here. */
 541         switch (dsk.type) {
 542         case BOOTINFO_DEV_TYPE_CFI:
 543                 return (cfi_read(buf, lba, nblk));
 544
 545         case BOOTINFO_DEV_TYPE_SDCARD:
 546                 return (altera_sdcard_read(buf, lba, nblk));
 547
 548         default:
 549                 return (-1);
 550         }
 551 }
 552
 553 static int
 554 dskread(void *buf, unsigned lba, unsigned nblk)
 555 {
 556 #if 0
 557     /*
 558      * XXXRW: For now, assume no partition table around the file system; it's
 559      * just in raw flash.
 560      */
 561     struct dos_partition *dp;
 562     struct disklabel *d;
 563     char *sec;
 564     unsigned i;
 565     uint8_t sl;
 566
 567     if (!dsk_meta) {
 568         sec = dmadat->secbuf;
 569         dsk.start = 0;
 570         if (drvread(sec, DOSBBSECTOR, 1))
 571             return -1;
 572         dp = (void *)(sec + DOSPARTOFF);
 573         sl = dsk.slice;
 574         if (sl < BASE_SLICE) {
 575             for (i = 0; i < NDOSPART; i++)
 576                 if (dp[i].dp_typ == DOSPTYP_386BSD &&
 577                     (dp[i].dp_flag & 0x80 || sl < BASE_SLICE)) {
 578                     sl = BASE_SLICE + i;
 579                     if (dp[i].dp_flag & 0x80 ||
 580                         dsk.slice == COMPATIBILITY_SLICE)
 581                         break;
 582                 }
 583             if (dsk.slice == WHOLE_DISK_SLICE)
 584                 dsk.slice = sl;
 585         }
 586         if (sl != WHOLE_DISK_SLICE) {
 587             if (sl != COMPATIBILITY_SLICE)
 588                 dp += sl - BASE_SLICE;
 589             if (dp->dp_typ != DOSPTYP_386BSD) {
 590                 printf("Invalid %s\n", "slice");
 591                 return -1;
 592             }
 593             dsk.start = le32toh(dp->dp_start);
 594         }
 595         if (drvread(sec, dsk.start + LABELSECTOR, 1))
 596                 return -1;
 597         d = (void *)(sec + LABELOFFSET);
 598         if (le32toh(d->d_magic) != DISKMAGIC ||
 599             le32toh(d->d_magic2) != DISKMAGIC) {
 600             if (dsk.part != RAW_PART) {
 601                 printf("Invalid %s\n", "label");
 602                 return -1;
 603             }
 604         } else {
 605             if (!dsk.init) {
 606                 if (le16toh(d->d_type) == DTYPE_SCSI)
 607                     dsk.type = TYPE_DA;
 608                 dsk.init++;
 609             }
 610             if (dsk.part >= le16toh(d->d_npartitions) ||
 611                 !(le32toh(d->d_partitions[dsk.part].p_size))) {
 612                 printf("Invalid %s\n", "partition");
 613                 return -1;
 614             }
 615             dsk.start += le32toh(d->d_partitions[dsk.part].p_offset);
 616             dsk.start -= le32toh(d->d_partitions[RAW_PART].p_offset);
 617         }
 618     }
 619     return drvread(buf, dsk.start + lba, nblk);
 620 #else
 621     return drvread(buf, lba, nblk);
 622 #endif
 623 }
 624
 625 void
 626 putchar(int c)
 627 {
 628     if (c == '\n')
 629         xputc('\r');
 630     xputc(c);
 631 }
 632
 633 static int
 634 xputc(int c)
 635 {
 636     if (ioctrl & IO_KEYBOARD)
 637         putc(c);
 638 #if 0
 639     if (ioctrl & IO_SERIAL)
 640         sio_putc(c);
 641 #endif
 642     return c;
 643 }
 644
 645 static int
 646 xgetc(int fn)
 647 {
 648     if (OPT_CHECK(RBX_NOINTR))
 649         return 0;
 650     for (;;) {
 651         if (ioctrl & IO_KEYBOARD && keyhit(0))
 652             return fn ? 1 : getc();
 653 #if 0
 654         if (ioctrl & IO_SERIAL && sio_ischar())
 655             return fn ? 1 : sio_getc();
 656 #endif
 657         if (fn)
 658             return 0;
 659     }
 660 }