main.c revision 332154
1/*- 2 * Copyright (c) 2000 Benno Rice <benno@jeamland.net> 3 * Copyright (c) 2000 Stephane Potvin <sepotvin@videotron.ca> 4 * Copyright (c) 2007-2008 Semihalf, Rafal Jaworowski <raj@semihalf.com> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29#include <sys/cdefs.h> 30__FBSDID("$FreeBSD: stable/11/stand/uboot/common/main.c 332154 2018-04-06 21:37:25Z kevans $"); 31#include <sys/param.h> 32 33#include <stand.h> 34 35#include "api_public.h" 36#include "bootstrap.h" 37#include "glue.h" 38#include "libuboot.h" 39 40#ifndef nitems 41#define nitems(x) (sizeof((x)) / sizeof((x)[0])) 42#endif 43 44#ifndef HEAP_SIZE 45#define HEAP_SIZE (1 * 1024 * 1024) 46#endif 47 48struct uboot_devdesc currdev; 49struct arch_switch archsw; /* MI/MD interface boundary */ 50int devs_no; 51 52uintptr_t uboot_heap_start; 53uintptr_t uboot_heap_end; 54 55struct device_type { 56 const char *name; 57 int type; 58} device_types[] = { 59 { "disk", DEV_TYP_STOR }, 60 { "ide", DEV_TYP_STOR | DT_STOR_IDE }, 61 { "mmc", DEV_TYP_STOR | DT_STOR_MMC }, 62 { "sata", DEV_TYP_STOR | DT_STOR_SATA }, 63 { "scsi", DEV_TYP_STOR | DT_STOR_SCSI }, 64 { "usb", DEV_TYP_STOR | DT_STOR_USB }, 65 { "net", DEV_TYP_NET } 66}; 67 68extern char end[]; 69extern char bootprog_info[]; 70 71extern unsigned char _etext[]; 72extern unsigned char _edata[]; 73extern unsigned char __bss_start[]; 74extern unsigned char __sbss_start[]; 75extern unsigned char __sbss_end[]; 76extern unsigned char _end[]; 77 78#ifdef LOADER_FDT_SUPPORT 79extern int command_fdt_internal(int argc, char *argv[]); 80#endif 81 82static void 83dump_sig(struct api_signature *sig) 84{ 85#ifdef DEBUG 86 printf("signature:\n"); 87 printf(" version\t= %d\n", sig->version); 88 printf(" checksum\t= 0x%08x\n", sig->checksum); 89 printf(" sc entry\t= 0x%08x\n", sig->syscall); 90#endif 91} 92 93static void 94dump_addr_info(void) 95{ 96#ifdef DEBUG 97 printf("\naddresses info:\n"); 98 printf(" _etext (sdata) = 0x%08x\n", (uint32_t)_etext); 99 printf(" _edata = 0x%08x\n", (uint32_t)_edata); 100 printf(" __sbss_start = 0x%08x\n", (uint32_t)__sbss_start); 101 printf(" __sbss_end = 0x%08x\n", (uint32_t)__sbss_end); 102 printf(" __sbss_start = 0x%08x\n", (uint32_t)__bss_start); 103 printf(" _end = 0x%08x\n", (uint32_t)_end); 104 printf(" syscall entry = 0x%08x\n", (uint32_t)syscall_ptr); 105#endif 106} 107 108static uint64_t 109memsize(struct sys_info *si, int flags) 110{ 111 uint64_t size; 112 int i; 113 114 size = 0; 115 for (i = 0; i < si->mr_no; i++) 116 if (si->mr[i].flags == flags && si->mr[i].size) 117 size += (si->mr[i].size); 118 119 return (size); 120} 121 122static void 123meminfo(void) 124{ 125 uint64_t size; 126 struct sys_info *si; 127 int t[3] = { MR_ATTR_DRAM, MR_ATTR_FLASH, MR_ATTR_SRAM }; 128 int i; 129 130 if ((si = ub_get_sys_info()) == NULL) 131 panic("could not retrieve system info"); 132 133 for (i = 0; i < 3; i++) { 134 size = memsize(si, t[i]); 135 if (size > 0) 136 printf("%s: %juMB\n", ub_mem_type(t[i]), 137 (uintmax_t)(size / 1024 / 1024)); 138 } 139} 140 141static const char * 142get_device_type(const char *devstr, int *devtype) 143{ 144 int i; 145 int namelen; 146 struct device_type *dt; 147 148 if (devstr) { 149 for (i = 0; i < nitems(device_types); i++) { 150 dt = &device_types[i]; 151 namelen = strlen(dt->name); 152 if (strncmp(dt->name, devstr, namelen) == 0) { 153 *devtype = dt->type; 154 return (devstr + namelen); 155 } 156 } 157 printf("Unknown device type '%s'\n", devstr); 158 } 159 160 *devtype = -1; 161 return (NULL); 162} 163 164static const char * 165device_typename(int type) 166{ 167 int i; 168 169 for (i = 0; i < nitems(device_types); i++) 170 if (device_types[i].type == type) 171 return (device_types[i].name); 172 173 return ("<unknown>"); 174} 175 176/* 177 * Parse a device string into type, unit, slice and partition numbers. A 178 * returned value of -1 for type indicates a search should be done for the 179 * first loadable device, otherwise a returned value of -1 for unit 180 * indicates a search should be done for the first loadable device of the 181 * given type. 182 * 183 * The returned values for slice and partition are interpreted by 184 * disk_open(). 185 * 186 * Valid device strings: For device types: 187 * 188 * <type_name> DEV_TYP_STOR, DEV_TYP_NET 189 * <type_name><unit> DEV_TYP_STOR, DEV_TYP_NET 190 * <type_name><unit>: DEV_TYP_STOR, DEV_TYP_NET 191 * <type_name><unit>:<slice> DEV_TYP_STOR 192 * <type_name><unit>:<slice>. DEV_TYP_STOR 193 * <type_name><unit>:<slice>.<partition> DEV_TYP_STOR 194 * 195 * For valid type names, see the device_types array, above. 196 * 197 * Slice numbers are 1-based. 0 is a wildcard. 198 */ 199static void 200get_load_device(int *type, int *unit, int *slice, int *partition) 201{ 202 char *devstr; 203 const char *p; 204 char *endp; 205 206 *type = -1; 207 *unit = -1; 208 *slice = 0; 209 *partition = -1; 210 211 devstr = ub_env_get("loaderdev"); 212 if (devstr == NULL) { 213 printf("U-Boot env: loaderdev not set, will probe all devices.\n"); 214 return; 215 } 216 printf("U-Boot env: loaderdev='%s'\n", devstr); 217 218 p = get_device_type(devstr, type); 219 220 /* Ignore optional spaces after the device name. */ 221 while (*p == ' ') 222 p++; 223 224 /* Unknown device name, or a known name without unit number. */ 225 if ((*type == -1) || (*p == '\0')) { 226 return; 227 } 228 229 /* Malformed unit number. */ 230 if (!isdigit(*p)) { 231 *type = -1; 232 return; 233 } 234 235 /* Guaranteed to extract a number from the string, as *p is a digit. */ 236 *unit = strtol(p, &endp, 10); 237 p = endp; 238 239 /* Known device name with unit number and nothing else. */ 240 if (*p == '\0') { 241 return; 242 } 243 244 /* Device string is malformed beyond unit number. */ 245 if (*p != ':') { 246 *type = -1; 247 *unit = -1; 248 return; 249 } 250 251 p++; 252 253 /* No slice and partition specification. */ 254 if ('\0' == *p ) 255 return; 256 257 /* Only DEV_TYP_STOR devices can have a slice specification. */ 258 if (!(*type & DEV_TYP_STOR)) { 259 *type = -1; 260 *unit = -1; 261 return; 262 } 263 264 *slice = strtoul(p, &endp, 10); 265 266 /* Malformed slice number. */ 267 if (p == endp) { 268 *type = -1; 269 *unit = -1; 270 *slice = 0; 271 return; 272 } 273 274 p = endp; 275 276 /* No partition specification. */ 277 if (*p == '\0') 278 return; 279 280 /* Device string is malformed beyond slice number. */ 281 if (*p != '.') { 282 *type = -1; 283 *unit = -1; 284 *slice = 0; 285 return; 286 } 287 288 p++; 289 290 /* No partition specification. */ 291 if (*p == '\0') 292 return; 293 294 *partition = strtol(p, &endp, 10); 295 p = endp; 296 297 /* Full, valid device string. */ 298 if (*endp == '\0') 299 return; 300 301 /* Junk beyond partition number. */ 302 *type = -1; 303 *unit = -1; 304 *slice = 0; 305 *partition = -1; 306} 307 308static void 309print_disk_probe_info() 310{ 311 char slice[32]; 312 char partition[32]; 313 314 if (currdev.d_disk.slice > 0) 315 sprintf(slice, "%d", currdev.d_disk.slice); 316 else 317 strcpy(slice, "<auto>"); 318 319 if (currdev.d_disk.partition >= 0) 320 sprintf(partition, "%d", currdev.d_disk.partition); 321 else 322 strcpy(partition, "<auto>"); 323 324 printf(" Checking unit=%d slice=%s partition=%s...", 325 currdev.dd.d_unit, slice, partition); 326 327} 328 329static int 330probe_disks(int devidx, int load_type, int load_unit, int load_slice, 331 int load_partition) 332{ 333 int open_result, unit; 334 struct open_file f; 335 336 currdev.d_disk.slice = load_slice; 337 currdev.d_disk.partition = load_partition; 338 339 f.f_devdata = &currdev; 340 open_result = -1; 341 342 if (load_type == -1) { 343 printf(" Probing all disk devices...\n"); 344 /* Try each disk in succession until one works. */ 345 for (currdev.dd.d_unit = 0; currdev.dd.d_unit < UB_MAX_DEV; 346 currdev.dd.d_unit++) { 347 print_disk_probe_info(); 348 open_result = devsw[devidx]->dv_open(&f, &currdev); 349 if (open_result == 0) { 350 printf(" good.\n"); 351 return (0); 352 } 353 printf("\n"); 354 } 355 return (-1); 356 } 357 358 if (load_unit == -1) { 359 printf(" Probing all %s devices...\n", device_typename(load_type)); 360 /* Try each disk of given type in succession until one works. */ 361 for (unit = 0; unit < UB_MAX_DEV; unit++) { 362 currdev.dd.d_unit = uboot_diskgetunit(load_type, unit); 363 if (currdev.dd.d_unit == -1) 364 break; 365 print_disk_probe_info(); 366 open_result = devsw[devidx]->dv_open(&f, &currdev); 367 if (open_result == 0) { 368 printf(" good.\n"); 369 return (0); 370 } 371 printf("\n"); 372 } 373 return (-1); 374 } 375 376 if ((currdev.dd.d_unit = uboot_diskgetunit(load_type, load_unit)) != -1) { 377 print_disk_probe_info(); 378 open_result = devsw[devidx]->dv_open(&f,&currdev); 379 if (open_result == 0) { 380 printf(" good.\n"); 381 return (0); 382 } 383 printf("\n"); 384 } 385 386 printf(" Requested disk type/unit/slice/partition not found\n"); 387 return (-1); 388} 389 390int 391main(int argc, char **argv) 392{ 393 struct api_signature *sig = NULL; 394 int load_type, load_unit, load_slice, load_partition; 395 int i; 396 const char *ldev; 397 398 /* 399 * We first check if a command line argument was passed to us containing 400 * API's signature address. If it wasn't then we try to search for the 401 * API signature via the usual hinted address. 402 * If we can't find the magic signature and related info, exit with a 403 * unique error code that U-Boot reports as "## Application terminated, 404 * rc = 0xnnbadab1". Hopefully 'badab1' looks enough like "bad api" to 405 * provide a clue. It's better than 0xffffffff anyway. 406 */ 407 if (!api_parse_cmdline_sig(argc, argv, &sig) && !api_search_sig(&sig)) 408 return (0x01badab1); 409 410 syscall_ptr = sig->syscall; 411 if (syscall_ptr == NULL) 412 return (0x02badab1); 413 414 if (sig->version > API_SIG_VERSION) 415 return (0x03badab1); 416 417 /* Clear BSS sections */ 418 bzero(__sbss_start, __sbss_end - __sbss_start); 419 bzero(__bss_start, _end - __bss_start); 420 421 /* 422 * Initialise the heap as early as possible. Once this is done, 423 * alloc() is usable. We are using the stack u-boot set up near the top 424 * of physical ram; hopefully there is sufficient space between the end 425 * of our bss and the bottom of the u-boot stack to avoid overlap. 426 */ 427 uboot_heap_start = round_page((uintptr_t)end); 428 uboot_heap_end = uboot_heap_start + HEAP_SIZE; 429 setheap((void *)uboot_heap_start, (void *)uboot_heap_end); 430 431 /* 432 * Set up console. 433 */ 434 cons_probe(); 435 printf("Compatible U-Boot API signature found @%p\n", sig); 436 437 printf("\n%s", bootprog_info); 438 printf("\n"); 439 440 dump_sig(sig); 441 dump_addr_info(); 442 443 meminfo(); 444 445 /* 446 * Enumerate U-Boot devices 447 */ 448 if ((devs_no = ub_dev_enum()) == 0) 449 panic("no U-Boot devices found"); 450 printf("Number of U-Boot devices: %d\n", devs_no); 451 452 get_load_device(&load_type, &load_unit, &load_slice, &load_partition); 453 454 /* 455 * March through the device switch probing for things. 456 */ 457 for (i = 0; devsw[i] != NULL; i++) { 458 459 if (devsw[i]->dv_init == NULL) 460 continue; 461 if ((devsw[i]->dv_init)() != 0) 462 continue; 463 464 printf("Found U-Boot device: %s\n", devsw[i]->dv_name); 465 466 currdev.dd.d_dev = devsw[i]; 467 currdev.dd.d_unit = 0; 468 469 if ((load_type == -1 || (load_type & DEV_TYP_STOR)) && 470 strcmp(devsw[i]->dv_name, "disk") == 0) { 471 if (probe_disks(i, load_type, load_unit, load_slice, 472 load_partition) == 0) 473 break; 474 } 475 476 if ((load_type == -1 || (load_type & DEV_TYP_NET)) && 477 strcmp(devsw[i]->dv_name, "net") == 0) 478 break; 479 } 480 481 /* 482 * If we couldn't find a boot device, return an error to u-boot. 483 * U-boot may be running a boot script that can try something different 484 * so returning an error is better than forcing a reboot. 485 */ 486 if (devsw[i] == NULL) { 487 printf("No boot device found!\n"); 488 return (0xbadef1ce); 489 } 490 491 ldev = uboot_fmtdev(&currdev); 492 env_setenv("currdev", EV_VOLATILE, ldev, uboot_setcurrdev, env_nounset); 493 env_setenv("loaddev", EV_VOLATILE, ldev, env_noset, env_nounset); 494 printf("Booting from %s\n", ldev); 495 496 setenv("LINES", "24", 1); /* optional */ 497 setenv("prompt", "loader>", 1); 498 499 archsw.arch_loadaddr = uboot_loadaddr; 500 archsw.arch_getdev = uboot_getdev; 501 archsw.arch_copyin = uboot_copyin; 502 archsw.arch_copyout = uboot_copyout; 503 archsw.arch_readin = uboot_readin; 504 archsw.arch_autoload = uboot_autoload; 505 506 interact(); /* doesn't return */ 507 508 return (0); 509} 510 511 512COMMAND_SET(heap, "heap", "show heap usage", command_heap); 513static int 514command_heap(int argc, char *argv[]) 515{ 516 517 printf("heap base at %p, top at %p, used %td\n", end, sbrk(0), 518 sbrk(0) - end); 519 520 return (CMD_OK); 521} 522 523COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot); 524static int 525command_reboot(int argc, char *argv[]) 526{ 527 528 printf("Resetting...\n"); 529 ub_reset(); 530 531 printf("Reset failed!\n"); 532 while (1); 533 __unreachable(); 534} 535 536COMMAND_SET(devinfo, "devinfo", "show U-Boot devices", command_devinfo); 537static int 538command_devinfo(int argc, char *argv[]) 539{ 540 int i; 541 542 if ((devs_no = ub_dev_enum()) == 0) { 543 command_errmsg = "no U-Boot devices found!?"; 544 return (CMD_ERROR); 545 } 546 547 printf("U-Boot devices:\n"); 548 for (i = 0; i < devs_no; i++) { 549 ub_dump_di(i); 550 printf("\n"); 551 } 552 return (CMD_OK); 553} 554 555COMMAND_SET(sysinfo, "sysinfo", "show U-Boot system info", command_sysinfo); 556static int 557command_sysinfo(int argc, char *argv[]) 558{ 559 struct sys_info *si; 560 561 if ((si = ub_get_sys_info()) == NULL) { 562 command_errmsg = "could not retrieve U-Boot sys info!?"; 563 return (CMD_ERROR); 564 } 565 566 printf("U-Boot system info:\n"); 567 ub_dump_si(si); 568 return (CMD_OK); 569} 570 571enum ubenv_action { 572 UBENV_UNKNOWN, 573 UBENV_SHOW, 574 UBENV_IMPORT 575}; 576 577static void 578handle_uboot_env_var(enum ubenv_action action, const char * var) 579{ 580 char ldvar[128]; 581 const char *val; 582 char *wrk; 583 int len; 584 585 /* 586 * On an import with the variable name formatted as ldname=ubname, 587 * import the uboot variable ubname into the loader variable ldname, 588 * otherwise the historical behavior is to import to uboot.ubname. 589 */ 590 if (action == UBENV_IMPORT) { 591 len = strcspn(var, "="); 592 if (len == 0) { 593 printf("name cannot start with '=': '%s'\n", var); 594 return; 595 } 596 if (var[len] == 0) { 597 strcpy(ldvar, "uboot."); 598 strncat(ldvar, var, sizeof(ldvar) - 7); 599 } else { 600 len = MIN(len, sizeof(ldvar) - 1); 601 strncpy(ldvar, var, len); 602 ldvar[len] = 0; 603 var = &var[len + 1]; 604 } 605 } 606 607 /* 608 * If the user prepended "uboot." (which is how they usually see these 609 * names) strip it off as a convenience. 610 */ 611 if (strncmp(var, "uboot.", 6) == 0) { 612 var = &var[6]; 613 } 614 615 /* If there is no variable name left, punt. */ 616 if (var[0] == 0) { 617 printf("empty variable name\n"); 618 return; 619 } 620 621 val = ub_env_get(var); 622 if (action == UBENV_SHOW) { 623 if (val == NULL) 624 printf("uboot.%s is not set\n", var); 625 else 626 printf("uboot.%s=%s\n", var, val); 627 } else if (action == UBENV_IMPORT) { 628 if (val != NULL) { 629 setenv(ldvar, val, 1); 630 } 631 } 632} 633 634static int 635command_ubenv(int argc, char *argv[]) 636{ 637 enum ubenv_action action; 638 const char *var; 639 int i; 640 641 action = UBENV_UNKNOWN; 642 if (argc > 1) { 643 if (strcasecmp(argv[1], "import") == 0) 644 action = UBENV_IMPORT; 645 else if (strcasecmp(argv[1], "show") == 0) 646 action = UBENV_SHOW; 647 } 648 if (action == UBENV_UNKNOWN) { 649 command_errmsg = "usage: 'ubenv <import|show> [var ...]"; 650 return (CMD_ERROR); 651 } 652 653 if (argc > 2) { 654 for (i = 2; i < argc; i++) 655 handle_uboot_env_var(action, argv[i]); 656 } else { 657 var = NULL; 658 for (;;) { 659 if ((var = ub_env_enum(var)) == NULL) 660 break; 661 handle_uboot_env_var(action, var); 662 } 663 } 664 665 return (CMD_OK); 666} 667COMMAND_SET(ubenv, "ubenv", "show or import U-Boot env vars", command_ubenv); 668 669#ifdef LOADER_FDT_SUPPORT 670/* 671 * Since proper fdt command handling function is defined in fdt_loader_cmd.c, 672 * and declaring it as extern is in contradiction with COMMAND_SET() macro 673 * (which uses static pointer), we're defining wrapper function, which 674 * calls the proper fdt handling routine. 675 */ 676static int 677command_fdt(int argc, char *argv[]) 678{ 679 680 return (command_fdt_internal(argc, argv)); 681} 682 683COMMAND_SET(fdt, "fdt", "flattened device tree handling", command_fdt); 684#endif 685