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>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
35 #include "api_public.h"
36 #include "bootstrap.h"
41 #define nitems(x) (sizeof((x)) / sizeof((x)[0]))
45 #define HEAP_SIZE (2 * 1024 * 1024)
48 struct uboot_devdesc currdev;
49 struct arch_switch archsw; /* MI/MD interface boundary */
52 uintptr_t uboot_heap_start;
53 uintptr_t uboot_heap_end;
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 }
70 extern unsigned char _etext[];
71 extern unsigned char _edata[];
72 extern unsigned char __bss_start[];
73 extern unsigned char __sbss_start[];
74 extern unsigned char __sbss_end[];
75 extern unsigned char _end[];
77 #ifdef LOADER_FDT_SUPPORT
78 extern int command_fdt_internal(int argc, char *argv[]);
82 dump_sig(struct api_signature *sig)
85 printf("signature:\n");
86 printf(" version\t= %d\n", sig->version);
87 printf(" checksum\t= 0x%08x\n", sig->checksum);
88 printf(" sc entry\t= 0x%08x\n", sig->syscall);
96 printf("\naddresses info:\n");
97 printf(" _etext (sdata) = 0x%08x\n", (uint32_t)_etext);
98 printf(" _edata = 0x%08x\n", (uint32_t)_edata);
99 printf(" __sbss_start = 0x%08x\n", (uint32_t)__sbss_start);
100 printf(" __sbss_end = 0x%08x\n", (uint32_t)__sbss_end);
101 printf(" __sbss_start = 0x%08x\n", (uint32_t)__bss_start);
102 printf(" _end = 0x%08x\n", (uint32_t)_end);
103 printf(" syscall entry = 0x%08x\n", (uint32_t)syscall_ptr);
108 memsize(struct sys_info *si, int flags)
114 for (i = 0; i < si->mr_no; i++)
115 if (si->mr[i].flags == flags && si->mr[i].size)
116 size += (si->mr[i].size);
126 int t[3] = { MR_ATTR_DRAM, MR_ATTR_FLASH, MR_ATTR_SRAM };
129 if ((si = ub_get_sys_info()) == NULL)
130 panic("could not retrieve system info");
132 for (i = 0; i < 3; i++) {
133 size = memsize(si, t[i]);
135 printf("%s: %juMB\n", ub_mem_type(t[i]),
136 (uintmax_t)(size / 1024 / 1024));
141 get_device_type(const char *devstr, int *devtype)
145 struct device_type *dt;
148 for (i = 0; i < nitems(device_types); i++) {
149 dt = &device_types[i];
150 namelen = strlen(dt->name);
151 if (strncmp(dt->name, devstr, namelen) == 0) {
153 return (devstr + namelen);
156 printf("Unknown device type '%s'\n", devstr);
159 *devtype = DEV_TYP_NONE;
164 device_typename(int type)
168 for (i = 0; i < nitems(device_types); i++)
169 if (device_types[i].type == type)
170 return (device_types[i].name);
172 return ("<unknown>");
176 * Parse a device string into type, unit, slice and partition numbers. A
177 * returned value of -1 for type indicates a search should be done for the
178 * first loadable device, otherwise a returned value of -1 for unit
179 * indicates a search should be done for the first loadable device of the
182 * The returned values for slice and partition are interpreted by
185 * The device string can be a standard loader(8) disk specifier:
187 * disk<unit>s<slice> disk0s1
188 * disk<unit>s<slice><partition> disk1s2a
189 * disk<unit>p<partition> disk0p4
191 * or one of the following formats:
193 * Valid device strings: For device types:
195 * <type_name> DEV_TYP_STOR, DEV_TYP_NET
196 * <type_name><unit> DEV_TYP_STOR, DEV_TYP_NET
197 * <type_name><unit>: DEV_TYP_STOR, DEV_TYP_NET
198 * <type_name><unit>:<slice> DEV_TYP_STOR
199 * <type_name><unit>:<slice>. DEV_TYP_STOR
200 * <type_name><unit>:<slice>.<partition> DEV_TYP_STOR
202 * For valid type names, see the device_types array, above.
204 * Slice numbers are 1-based. 0 is a wildcard.
207 get_load_device(int *type, int *unit, int *slice, int *partition)
209 struct disk_devdesc *dev;
214 *type = DEV_TYP_NONE;
216 *slice = D_SLICEWILD;
217 *partition = D_PARTWILD;
219 devstr = ub_env_get("loaderdev");
220 if (devstr == NULL) {
221 printf("U-Boot env: loaderdev not set, will probe all devices.\n");
224 printf("U-Boot env: loaderdev='%s'\n", devstr);
226 p = get_device_type(devstr, type);
229 * If type is DEV_TYP_STOR we have a disk-like device. If the remainder
230 * of the string contains spaces, dots, or a colon in any location other
231 * than the last char, it's legacy format. Otherwise it might be
232 * standard loader(8) format (e.g., disk0s2a or mmc1p12), so try to
233 * parse the remainder of the string as such, and if it works, return
234 * those results. Otherwise we'll fall through to the code that parses
237 * disk_parsedev now assumes that it points to the start of the device
238 * name, but since it doesn't know about uboot's usage, just subtract 4
239 * since it always adds 4. This is the least-bad solution since it makes
240 * all the other loader code easier (might be better to create a fake
241 * 'disk...' string, but that's more work than uboot is worth).
243 if (*type & DEV_TYP_STOR) {
244 size_t len = strlen(p);
245 if (strcspn(p, " .") == len && strcspn(p, ":") >= len - 1 &&
246 disk_parsedev((struct devdesc **)&dev, p - 4, NULL) == 0) { /* Hack */
247 *unit = dev->dd.d_unit;
248 *slice = dev->d_slice;
249 *partition = dev->d_partition;
255 /* Ignore optional spaces after the device name. */
259 /* Unknown device name, or a known name without unit number. */
260 if ((*type == DEV_TYP_NONE) || (*p == '\0')) {
264 /* Malformed unit number. */
266 *type = DEV_TYP_NONE;
270 /* Guaranteed to extract a number from the string, as *p is a digit. */
271 *unit = strtol(p, &endp, 10);
274 /* Known device name with unit number and nothing else. */
279 /* Device string is malformed beyond unit number. */
281 *type = DEV_TYP_NONE;
288 /* No slice and partition specification. */
292 /* Only DEV_TYP_STOR devices can have a slice specification. */
293 if (!(*type & DEV_TYP_STOR)) {
294 *type = DEV_TYP_NONE;
299 *slice = strtoul(p, &endp, 10);
301 /* Malformed slice number. */
303 *type = DEV_TYP_NONE;
305 *slice = D_SLICEWILD;
311 /* No partition specification. */
315 /* Device string is malformed beyond slice number. */
317 *type = DEV_TYP_NONE;
319 *slice = D_SLICEWILD;
325 /* No partition specification. */
329 *partition = strtol(p, &endp, 10);
332 /* Full, valid device string. */
336 /* Junk beyond partition number. */
337 *type = DEV_TYP_NONE;
339 *slice = D_SLICEWILD;
340 *partition = D_PARTWILD;
344 print_disk_probe_info()
349 if (currdev.d_disk.d_slice == D_SLICENONE)
350 strlcpy(slice, "<none>", sizeof(slice));
351 else if (currdev.d_disk.d_slice == D_SLICEWILD)
352 strlcpy(slice, "<auto>", sizeof(slice));
354 snprintf(slice, sizeof(slice), "%d", currdev.d_disk.d_slice);
356 if (currdev.d_disk.d_partition == D_PARTNONE)
357 strlcpy(partition, "<none>", sizeof(partition));
358 else if (currdev.d_disk.d_partition == D_PARTWILD)
359 strlcpy(partition, "<auto>", sizeof(partition));
361 snprintf(partition, sizeof(partition), "%d",
362 currdev.d_disk.d_partition);
364 printf(" Checking unit=%d slice=%s partition=%s...",
365 currdev.dd.d_unit, slice, partition);
370 probe_disks(int devidx, int load_type, int load_unit, int load_slice,
373 int open_result, unit;
376 currdev.d_disk.d_slice = load_slice;
377 currdev.d_disk.d_partition = load_partition;
379 f.f_devdata = &currdev;
382 if (load_type == -1) {
383 printf(" Probing all disk devices...\n");
384 /* Try each disk in succession until one works. */
385 for (currdev.dd.d_unit = 0; currdev.dd.d_unit < UB_MAX_DEV;
386 currdev.dd.d_unit++) {
387 print_disk_probe_info();
388 open_result = devsw[devidx]->dv_open(&f, &currdev);
389 if (open_result == 0) {
398 if (load_unit == -1) {
399 printf(" Probing all %s devices...\n", device_typename(load_type));
400 /* Try each disk of given type in succession until one works. */
401 for (unit = 0; unit < UB_MAX_DEV; unit++) {
402 currdev.dd.d_unit = uboot_diskgetunit(load_type, unit);
403 if (currdev.dd.d_unit == -1)
405 print_disk_probe_info();
406 open_result = devsw[devidx]->dv_open(&f, &currdev);
407 if (open_result == 0) {
416 if ((currdev.dd.d_unit = uboot_diskgetunit(load_type, load_unit)) != -1) {
417 print_disk_probe_info();
418 open_result = devsw[devidx]->dv_open(&f,&currdev);
419 if (open_result == 0) {
426 printf(" Requested disk type/unit/slice/partition not found\n");
431 main(int argc, char **argv)
433 struct api_signature *sig = NULL;
434 int load_type, load_unit, load_slice, load_partition;
439 * We first check if a command line argument was passed to us containing
440 * API's signature address. If it wasn't then we try to search for the
441 * API signature via the usual hinted address.
442 * If we can't find the magic signature and related info, exit with a
443 * unique error code that U-Boot reports as "## Application terminated,
444 * rc = 0xnnbadab1". Hopefully 'badab1' looks enough like "bad api" to
445 * provide a clue. It's better than 0xffffffff anyway.
447 if (!api_parse_cmdline_sig(argc, argv, &sig) && !api_search_sig(&sig))
450 syscall_ptr = sig->syscall;
451 if (syscall_ptr == NULL)
454 if (sig->version > API_SIG_VERSION)
457 /* Clear BSS sections */
458 bzero(__sbss_start, __sbss_end - __sbss_start);
459 bzero(__bss_start, _end - __bss_start);
462 * Initialise the heap as early as possible. Once this is done,
463 * alloc() is usable. We are using the stack u-boot set up near the top
464 * of physical ram; hopefully there is sufficient space between the end
465 * of our bss and the bottom of the u-boot stack to avoid overlap.
467 uboot_heap_start = round_page((uintptr_t)end);
468 uboot_heap_end = uboot_heap_start + HEAP_SIZE;
469 setheap((void *)uboot_heap_start, (void *)uboot_heap_end);
475 printf("Compatible U-Boot API signature found @%p\n", sig);
477 printf("\n%s", bootprog_info);
485 archsw.arch_loadaddr = uboot_loadaddr;
486 archsw.arch_getdev = uboot_getdev;
487 archsw.arch_copyin = uboot_copyin;
488 archsw.arch_copyout = uboot_copyout;
489 archsw.arch_readin = uboot_readin;
490 archsw.arch_autoload = uboot_autoload;
492 /* Set up currdev variable to have hooks in place. */
493 env_setenv("currdev", EV_VOLATILE, "", uboot_setcurrdev, env_nounset);
496 * Enumerate U-Boot devices
498 if ((devs_no = ub_dev_enum()) == 0) {
499 printf("no U-Boot devices found");
502 printf("Number of U-Boot devices: %d\n", devs_no);
504 get_load_device(&load_type, &load_unit, &load_slice, &load_partition);
507 * March through the device switch probing for things.
509 for (i = 0; devsw[i] != NULL; i++) {
511 if (devsw[i]->dv_init == NULL)
513 if ((devsw[i]->dv_init)() != 0)
516 printf("Found U-Boot device: %s\n", devsw[i]->dv_name);
518 currdev.dd.d_dev = devsw[i];
519 currdev.dd.d_unit = 0;
521 if ((load_type == DEV_TYP_NONE || (load_type & DEV_TYP_STOR)) &&
522 strcmp(devsw[i]->dv_name, "disk") == 0) {
523 if (probe_disks(i, load_type, load_unit, load_slice,
524 load_partition) == 0)
528 if ((load_type == DEV_TYP_NONE || (load_type & DEV_TYP_NET)) &&
529 strcmp(devsw[i]->dv_name, "net") == 0)
534 * If we couldn't find a boot device, return an error to u-boot.
535 * U-boot may be running a boot script that can try something different
536 * so returning an error is better than forcing a reboot.
538 if (devsw[i] == NULL) {
539 printf("No boot device found!\n");
543 ldev = devformat(&currdev.dd);
544 env_setenv("currdev", EV_VOLATILE, ldev, uboot_setcurrdev, env_nounset);
545 env_setenv("loaddev", EV_VOLATILE, ldev, env_noset, env_nounset);
546 printf("Booting from %s\n", ldev);
549 setenv("LINES", "24", 1); /* optional */
550 setenv("prompt", "loader>", 1);
552 setenv("usefdt", "1", 1);
555 interact(); /* doesn't return */
561 COMMAND_SET(heap, "heap", "show heap usage", command_heap);
563 command_heap(int argc, char *argv[])
566 printf("heap base at %p, top at %p, used %td\n", end, sbrk(0),
572 COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot);
574 command_reboot(int argc, char *argv[])
577 printf("Resetting...\n");
580 printf("Reset failed!\n");
585 COMMAND_SET(devinfo, "devinfo", "show U-Boot devices", command_devinfo);
587 command_devinfo(int argc, char *argv[])
591 if ((devs_no = ub_dev_enum()) == 0) {
592 command_errmsg = "no U-Boot devices found!?";
596 printf("U-Boot devices:\n");
597 for (i = 0; i < devs_no; i++) {
604 COMMAND_SET(sysinfo, "sysinfo", "show U-Boot system info", command_sysinfo);
606 command_sysinfo(int argc, char *argv[])
610 if ((si = ub_get_sys_info()) == NULL) {
611 command_errmsg = "could not retrieve U-Boot sys info!?";
615 printf("U-Boot system info:\n");
627 handle_uboot_env_var(enum ubenv_action action, const char * var)
635 * On an import with the variable name formatted as ldname=ubname,
636 * import the uboot variable ubname into the loader variable ldname,
637 * otherwise the historical behavior is to import to uboot.ubname.
639 if (action == UBENV_IMPORT) {
640 len = strcspn(var, "=");
642 printf("name cannot start with '=': '%s'\n", var);
646 strcpy(ldvar, "uboot.");
647 strncat(ldvar, var, sizeof(ldvar) - 7);
649 len = MIN(len, sizeof(ldvar) - 1);
650 strncpy(ldvar, var, len);
657 * If the user prepended "uboot." (which is how they usually see these
658 * names) strip it off as a convenience.
660 if (strncmp(var, "uboot.", 6) == 0) {
664 /* If there is no variable name left, punt. */
666 printf("empty variable name\n");
670 val = ub_env_get(var);
671 if (action == UBENV_SHOW) {
673 printf("uboot.%s is not set\n", var);
675 printf("uboot.%s=%s\n", var, val);
676 } else if (action == UBENV_IMPORT) {
678 setenv(ldvar, val, 1);
684 command_ubenv(int argc, char *argv[])
686 enum ubenv_action action;
690 action = UBENV_UNKNOWN;
692 if (strcasecmp(argv[1], "import") == 0)
693 action = UBENV_IMPORT;
694 else if (strcasecmp(argv[1], "show") == 0)
697 if (action == UBENV_UNKNOWN) {
698 command_errmsg = "usage: 'ubenv <import|show> [var ...]";
703 for (i = 2; i < argc; i++)
704 handle_uboot_env_var(action, argv[i]);
708 if ((var = ub_env_enum(var)) == NULL)
710 handle_uboot_env_var(action, var);
716 COMMAND_SET(ubenv, "ubenv", "show or import U-Boot env vars", command_ubenv);
718 #ifdef LOADER_FDT_SUPPORT
720 * Since proper fdt command handling function is defined in fdt_loader_cmd.c,
721 * and declaring it as extern is in contradiction with COMMAND_SET() macro
722 * (which uses static pointer), we're defining wrapper function, which
723 * calls the proper fdt handling routine.
726 command_fdt(int argc, char *argv[])
729 return (command_fdt_internal(argc, argv));
732 COMMAND_SET(fdt, "fdt", "flattened device tree handling", command_fdt);