2 * Copyright (c) 2001 William L. Pitts
5 * Redistribution and use in source and binary forms are freely
6 * permitted provided that the above copyright notice and this
7 * paragraph and the following disclaimer are duplicated in all
10 * This software is provided "AS IS" and without any express or
11 * implied warranties, including, without limitation, the implied
12 * warranties of merchantability and fitness for a particular
19 #include <environment.h>
25 #include <linux/linkage.h>
29 * A very simple ELF64 loader, assumes the image is valid, returns the
30 * entry point address.
32 * Note if U-Boot is 32-bit, the loader assumes the to segment's
33 * physical address and size is within the lower 32-bit address space.
35 static unsigned long load_elf64_image_phdr(unsigned long addr)
37 Elf64_Ehdr *ehdr; /* Elf header structure pointer */
38 Elf64_Phdr *phdr; /* Program header structure pointer */
41 ehdr = (Elf64_Ehdr *)addr;
42 phdr = (Elf64_Phdr *)(addr + (ulong)ehdr->e_phoff);
44 /* Load each program header */
45 for (i = 0; i < ehdr->e_phnum; ++i) {
46 void *dst = (void *)(ulong)phdr->p_paddr;
47 void *src = (void *)addr + phdr->p_offset;
49 debug("Loading phdr %i to 0x%p (%lu bytes)\n",
50 i, dst, (ulong)phdr->p_filesz);
52 memcpy(dst, src, phdr->p_filesz);
53 if (phdr->p_filesz != phdr->p_memsz)
54 memset(dst + phdr->p_filesz, 0x00,
55 phdr->p_memsz - phdr->p_filesz);
56 flush_cache((unsigned long)dst, phdr->p_filesz);
60 if (ehdr->e_machine == EM_PPC64 && (ehdr->e_flags &
61 EF_PPC64_ELFV1_ABI)) {
63 * For the 64-bit PowerPC ELF V1 ABI, e_entry is a function
64 * descriptor pointer with the first double word being the
65 * address of the entry point of the function.
67 uintptr_t addr = ehdr->e_entry;
69 return *(Elf64_Addr *)addr;
75 static unsigned long load_elf64_image_shdr(unsigned long addr)
77 Elf64_Ehdr *ehdr; /* Elf header structure pointer */
78 Elf64_Shdr *shdr; /* Section header structure pointer */
79 unsigned char *strtab = 0; /* String table pointer */
80 unsigned char *image; /* Binary image pointer */
81 int i; /* Loop counter */
83 ehdr = (Elf64_Ehdr *)addr;
85 /* Find the section header string table for output info */
86 shdr = (Elf64_Shdr *)(addr + (ulong)ehdr->e_shoff +
87 (ehdr->e_shstrndx * sizeof(Elf64_Shdr)));
89 if (shdr->sh_type == SHT_STRTAB)
90 strtab = (unsigned char *)(addr + (ulong)shdr->sh_offset);
92 /* Load each appropriate section */
93 for (i = 0; i < ehdr->e_shnum; ++i) {
94 shdr = (Elf64_Shdr *)(addr + (ulong)ehdr->e_shoff +
95 (i * sizeof(Elf64_Shdr)));
97 if (!(shdr->sh_flags & SHF_ALLOC) ||
98 shdr->sh_addr == 0 || shdr->sh_size == 0) {
103 debug("%sing %s @ 0x%08lx (%ld bytes)\n",
104 (shdr->sh_type == SHT_NOBITS) ? "Clear" : "Load",
105 &strtab[shdr->sh_name],
106 (unsigned long)shdr->sh_addr,
107 (long)shdr->sh_size);
110 if (shdr->sh_type == SHT_NOBITS) {
111 memset((void *)(uintptr_t)shdr->sh_addr, 0,
114 image = (unsigned char *)addr + (ulong)shdr->sh_offset;
115 memcpy((void *)(uintptr_t)shdr->sh_addr,
116 (const void *)image, shdr->sh_size);
118 flush_cache(rounddown(shdr->sh_addr, ARCH_DMA_MINALIGN),
119 roundup((shdr->sh_addr + shdr->sh_size),
121 rounddown(shdr->sh_addr, ARCH_DMA_MINALIGN));
124 if (ehdr->e_machine == EM_PPC64 && (ehdr->e_flags &
125 EF_PPC64_ELFV1_ABI)) {
127 * For the 64-bit PowerPC ELF V1 ABI, e_entry is a function
128 * descriptor pointer with the first double word being the
129 * address of the entry point of the function.
131 uintptr_t addr = ehdr->e_entry;
133 return *(Elf64_Addr *)addr;
136 return ehdr->e_entry;
140 * A very simple ELF loader, assumes the image is valid, returns the
141 * entry point address.
143 * The loader firstly reads the EFI class to see if it's a 64-bit image.
144 * If yes, call the ELF64 loader. Otherwise continue with the ELF32 loader.
146 static unsigned long load_elf_image_phdr(unsigned long addr)
148 Elf32_Ehdr *ehdr; /* Elf header structure pointer */
149 Elf32_Phdr *phdr; /* Program header structure pointer */
152 ehdr = (Elf32_Ehdr *)addr;
153 if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
154 return load_elf64_image_phdr(addr);
156 phdr = (Elf32_Phdr *)(addr + ehdr->e_phoff);
158 /* Load each program header */
159 for (i = 0; i < ehdr->e_phnum; ++i) {
160 void *dst = (void *)(uintptr_t)phdr->p_paddr;
161 void *src = (void *)addr + phdr->p_offset;
163 debug("Loading phdr %i to 0x%p (%i bytes)\n",
164 i, dst, phdr->p_filesz);
166 memcpy(dst, src, phdr->p_filesz);
167 if (phdr->p_filesz != phdr->p_memsz)
168 memset(dst + phdr->p_filesz, 0x00,
169 phdr->p_memsz - phdr->p_filesz);
170 flush_cache((unsigned long)dst, phdr->p_filesz);
174 return ehdr->e_entry;
177 static unsigned long load_elf_image_shdr(unsigned long addr)
179 Elf32_Ehdr *ehdr; /* Elf header structure pointer */
180 Elf32_Shdr *shdr; /* Section header structure pointer */
181 unsigned char *strtab = 0; /* String table pointer */
182 unsigned char *image; /* Binary image pointer */
183 int i; /* Loop counter */
185 ehdr = (Elf32_Ehdr *)addr;
186 if (ehdr->e_ident[EI_CLASS] == ELFCLASS64)
187 return load_elf64_image_shdr(addr);
189 /* Find the section header string table for output info */
190 shdr = (Elf32_Shdr *)(addr + ehdr->e_shoff +
191 (ehdr->e_shstrndx * sizeof(Elf32_Shdr)));
193 if (shdr->sh_type == SHT_STRTAB)
194 strtab = (unsigned char *)(addr + shdr->sh_offset);
196 /* Load each appropriate section */
197 for (i = 0; i < ehdr->e_shnum; ++i) {
198 shdr = (Elf32_Shdr *)(addr + ehdr->e_shoff +
199 (i * sizeof(Elf32_Shdr)));
201 if (!(shdr->sh_flags & SHF_ALLOC) ||
202 shdr->sh_addr == 0 || shdr->sh_size == 0) {
207 debug("%sing %s @ 0x%08lx (%ld bytes)\n",
208 (shdr->sh_type == SHT_NOBITS) ? "Clear" : "Load",
209 &strtab[shdr->sh_name],
210 (unsigned long)shdr->sh_addr,
211 (long)shdr->sh_size);
214 if (shdr->sh_type == SHT_NOBITS) {
215 memset((void *)(uintptr_t)shdr->sh_addr, 0,
218 image = (unsigned char *)addr + shdr->sh_offset;
219 memcpy((void *)(uintptr_t)shdr->sh_addr,
220 (const void *)image, shdr->sh_size);
222 flush_cache(rounddown(shdr->sh_addr, ARCH_DMA_MINALIGN),
223 roundup((shdr->sh_addr + shdr->sh_size),
225 rounddown(shdr->sh_addr, ARCH_DMA_MINALIGN));
228 return ehdr->e_entry;
231 /* Allow ports to override the default behavior */
232 static unsigned long do_bootelf_exec(ulong (*entry)(int, char * const[]),
233 int argc, char * const argv[])
238 * pass address parameter as argv[0] (aka command name),
239 * and all remaining args
241 ret = entry(argc, argv);
247 * Determine if a valid ELF image exists at the given memory location.
248 * First look at the ELF header magic field, then make sure that it is
251 int valid_elf_image(unsigned long addr)
253 Elf32_Ehdr *ehdr; /* Elf header structure pointer */
255 ehdr = (Elf32_Ehdr *)addr;
257 if (!IS_ELF(*ehdr)) {
258 printf("## No elf image at address 0x%08lx\n", addr);
262 if (ehdr->e_type != ET_EXEC) {
263 printf("## Not a 32-bit elf image at address 0x%08lx\n", addr);
270 /* Interpreter command to boot an arbitrary ELF image from memory */
271 int do_bootelf(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
273 unsigned long addr; /* Address of the ELF image */
274 unsigned long rc; /* Return value from user code */
276 const char *ep = env_get("autostart");
279 /* Consume 'bootelf' */
282 /* Check for flag. */
283 if (argc >= 1 && (argv[0][0] == '-' && \
284 (argv[0][1] == 'p' || argv[0][1] == 's'))) {
289 /* Check for address. */
290 if (argc >= 1 && strict_strtoul(argv[0], 16, &addr) != -EINVAL) {
291 /* Consume address */
296 if (!valid_elf_image(addr))
299 if (sload && sload[1] == 'p')
300 addr = load_elf_image_phdr(addr);
302 addr = load_elf_image_shdr(addr);
304 if (ep && !strcmp(ep, "no"))
307 printf("## Starting application at 0x%08lx ...\n", addr);
310 * pass address parameter as argv[0] (aka command name),
311 * and all remaining args
313 rc = do_bootelf_exec((void *)addr, argc, argv);
317 printf("## Application terminated, rc = 0x%lx\n", rc);
323 * Interpreter command to boot VxWorks from a memory image. The image can
324 * be either an ELF image or a raw binary. Will attempt to setup the
325 * bootline and other parameters correctly.
327 int do_bootvx(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
329 unsigned long addr; /* Address of image */
330 unsigned long bootaddr = 0; /* Address to put the bootline */
331 char *bootline; /* Text of the bootline */
332 char *tmp; /* Temporary char pointer */
333 char build_buf[128]; /* Buffer for building the bootline */
337 struct e820_info *info;
338 struct e820_entry *data;
339 struct efi_gop_info *gop;
340 struct vesa_mode_info *vesa = &mode_info.vesa;
344 * Check the loadaddr variable.
345 * If we don't know where the image is then we're done.
350 addr = simple_strtoul(argv[1], NULL, 16);
352 #if defined(CONFIG_CMD_NET)
354 * Check to see if we need to tftp the image ourselves
357 if ((argc == 2) && (strcmp(argv[1], "tftp") == 0)) {
358 if (net_loop(TFTPGET) <= 0)
360 printf("Automatic boot of VxWorks image at address 0x%08lx ...\n",
366 * This should equate to
367 * NV_RAM_ADRS + NV_BOOT_OFFSET + NV_ENET_OFFSET
368 * from the VxWorks BSP header files.
369 * This will vary from board to board
371 #if defined(CONFIG_SYS_VXWORKS_MAC_PTR)
372 tmp = (char *)CONFIG_SYS_VXWORKS_MAC_PTR;
373 eth_env_get_enetaddr("ethaddr", (uchar *)build_buf);
374 memcpy(tmp, build_buf, 6);
376 puts("## Ethernet MAC address not copied to NV RAM\n");
381 * Get VxWorks's physical memory base address from environment,
382 * if we don't specify it in the environment, use a default one.
384 base = env_get_hex("vx_phys_mem_base", VXWORKS_PHYS_MEM_BASE);
385 data = (struct e820_entry *)(base + E820_DATA_OFFSET);
386 info = (struct e820_info *)(base + E820_INFO_OFFSET);
388 memset(info, 0, sizeof(struct e820_info));
389 info->sign = E820_SIGNATURE;
390 info->entries = install_e820_map(E820MAX, data);
391 info->addr = (info->entries - 1) * sizeof(struct e820_entry) +
395 * Explicitly clear the bootloader image size otherwise if memory
396 * at this offset happens to contain some garbage data, the final
397 * available memory size for the kernel is insane.
399 *(u32 *)(base + BOOT_IMAGE_SIZE_OFFSET) = 0;
402 * Prepare compatible framebuffer information block.
403 * The VESA mode has to be 32-bit RGBA.
405 if (vesa->x_resolution && vesa->y_resolution) {
406 gop = (struct efi_gop_info *)(base + EFI_GOP_INFO_OFFSET);
407 gop->magic = EFI_GOP_INFO_MAGIC;
408 gop->info.version = 0;
409 gop->info.width = vesa->x_resolution;
410 gop->info.height = vesa->y_resolution;
411 gop->info.pixel_format = EFI_GOT_RGBA8;
412 gop->info.pixels_per_scanline = vesa->bytes_per_scanline / 4;
413 gop->fb_base = vesa->phys_base_ptr;
414 gop->fb_size = vesa->bytes_per_scanline * vesa->y_resolution;
419 * Use bootaddr to find the location in memory that VxWorks
420 * will look for the bootline string. The default value is
421 * (LOCAL_MEM_LOCAL_ADRS + BOOT_LINE_OFFSET) as defined by
422 * VxWorks BSP. For example, on PowerPC it defaults to 0x4200.
424 tmp = env_get("bootaddr");
427 bootaddr = base + X86_BOOT_LINE_OFFSET;
429 printf("## VxWorks bootline address not specified\n");
435 bootaddr = simple_strtoul(tmp, NULL, 16);
438 * Check to see if the bootline is defined in the 'bootargs' parameter.
439 * If it is not defined, we may be able to construct the info.
441 bootline = env_get("bootargs");
443 tmp = env_get("bootdev");
445 strcpy(build_buf, tmp);
448 printf("## VxWorks boot device not specified\n");
451 tmp = env_get("bootfile");
453 ptr += sprintf(build_buf + ptr, "host:%s ", tmp);
455 ptr += sprintf(build_buf + ptr, "host:vxWorks ");
458 * The following parameters are only needed if 'bootdev'
459 * is an ethernet device, otherwise they are optional.
461 tmp = env_get("ipaddr");
463 ptr += sprintf(build_buf + ptr, "e=%s", tmp);
464 tmp = env_get("netmask");
466 u32 mask = env_get_ip("netmask").s_addr;
467 ptr += sprintf(build_buf + ptr,
468 ":%08x ", ntohl(mask));
470 ptr += sprintf(build_buf + ptr, " ");
474 tmp = env_get("serverip");
476 ptr += sprintf(build_buf + ptr, "h=%s ", tmp);
478 tmp = env_get("gatewayip");
480 ptr += sprintf(build_buf + ptr, "g=%s ", tmp);
482 tmp = env_get("hostname");
484 ptr += sprintf(build_buf + ptr, "tn=%s ", tmp);
486 tmp = env_get("othbootargs");
488 strcpy(build_buf + ptr, tmp);
492 bootline = build_buf;
495 memcpy((void *)bootaddr, bootline, max(strlen(bootline), (size_t)255));
496 flush_cache(bootaddr, max(strlen(bootline), (size_t)255));
497 printf("## Using bootline (@ 0x%lx): %s\n", bootaddr, (char *)bootaddr);
500 * If the data at the load address is an elf image, then
501 * treat it like an elf image. Otherwise, assume that it is a
504 if (valid_elf_image(addr))
505 addr = load_elf_image_phdr(addr);
507 puts("## Not an ELF image, assuming binary\n");
509 printf("## Starting vxWorks at 0x%08lx ...\n", addr);
512 #if defined(CONFIG_ARM64) && defined(CONFIG_ARMV8_PSCI)
518 /* VxWorks on x86 uses stack to pass parameters */
519 ((asmlinkage void (*)(int))addr)(0);
521 ((void (*)(int))addr)(0);
524 puts("## vxWorks terminated\n");
530 bootelf, CONFIG_SYS_MAXARGS, 0, do_bootelf,
531 "Boot from an ELF image in memory",
532 "[-p|-s] [address]\n"
533 "\t- load ELF image at [address] via program headers (-p)\n"
534 "\t or via section headers (-s)"
538 bootvx, 2, 0, do_bootvx,
539 "Boot vxWorks from an ELF image",
540 " [address] - load address of vxWorks ELF image."