2 * QEMU Executable loader
4 * Copyright (c) 2006 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * Gunzip functionality in this file is derived from u-boot:
26 * (C) Copyright 2008 Semihalf
28 * (C) Copyright 2000-2005
29 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
31 * This program is free software; you can redistribute it and/or
32 * modify it under the terms of the GNU General Public License as
33 * published by the Free Software Foundation; either version 2 of
34 * the License, or (at your option) any later version.
36 * This program is distributed in the hope that it will be useful,
37 * but WITHOUT ANY WARRANTY; without even the implied warranty of
38 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39 * GNU General Public License for more details.
41 * You should have received a copy of the GNU General Public License along
42 * with this program; if not, see <http://www.gnu.org/licenses/>.
46 #include "disas/disas.h"
49 #include "uboot_image.h"
52 #include "exec/memory.h"
53 #include "exec/address-spaces.h"
57 static int roms_loaded;
59 /* return the size or -1 if error */
60 int get_image_size(const char *filename)
63 fd = open(filename, O_RDONLY | O_BINARY);
66 size = lseek(fd, 0, SEEK_END);
71 /* return the size or -1 if error */
72 /* deprecated, because caller does not specify buffer size! */
73 int load_image(const char *filename, uint8_t *addr)
76 fd = open(filename, O_RDONLY | O_BINARY);
79 size = lseek(fd, 0, SEEK_END);
80 lseek(fd, 0, SEEK_SET);
81 if (read(fd, addr, size) != size) {
89 /* read()-like version */
90 ssize_t read_targphys(const char *name,
91 int fd, hwaddr dst_addr, size_t nbytes)
96 buf = g_malloc(nbytes);
97 did = read(fd, buf, nbytes);
99 rom_add_blob_fixed("read", buf, did, dst_addr);
104 /* return the size or -1 if error */
105 int load_image_targphys(const char *filename,
106 hwaddr addr, uint64_t max_sz)
110 size = get_image_size(filename);
115 rom_add_file_fixed(filename, addr, -1);
120 void pstrcpy_targphys(const char *name, hwaddr dest, int buf_size,
126 if (buf_size <= 0) return;
127 nulp = memchr(source, 0, buf_size);
129 rom_add_blob_fixed(name, source, (nulp - source) + 1, dest);
131 rom_add_blob_fixed(name, source, buf_size, dest);
132 ptr = rom_ptr(dest + buf_size - 1);
141 uint32_t a_info; /* Use macros N_MAGIC, etc for access */
142 uint32_t a_text; /* length of text, in bytes */
143 uint32_t a_data; /* length of data, in bytes */
144 uint32_t a_bss; /* length of uninitialized data area, in bytes */
145 uint32_t a_syms; /* length of symbol table data in file, in bytes */
146 uint32_t a_entry; /* start address */
147 uint32_t a_trsize; /* length of relocation info for text, in bytes */
148 uint32_t a_drsize; /* length of relocation info for data, in bytes */
151 static void bswap_ahdr(struct exec *e)
153 bswap32s(&e->a_info);
154 bswap32s(&e->a_text);
155 bswap32s(&e->a_data);
157 bswap32s(&e->a_syms);
158 bswap32s(&e->a_entry);
159 bswap32s(&e->a_trsize);
160 bswap32s(&e->a_drsize);
163 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
168 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
169 #define N_TXTOFF(x) \
170 (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) : \
171 (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
172 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
173 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
175 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
177 #define N_DATADDR(x, target_page_size) \
178 (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
179 : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
182 int load_aout(const char *filename, hwaddr addr, int max_sz,
183 int bswap_needed, hwaddr target_page_size)
190 fd = open(filename, O_RDONLY | O_BINARY);
194 size = read(fd, &e, sizeof(e));
207 if (e.a_text + e.a_data > max_sz)
209 lseek(fd, N_TXTOFF(e), SEEK_SET);
210 size = read_targphys(filename, fd, addr, e.a_text + e.a_data);
215 if (N_DATADDR(e, target_page_size) + e.a_data > max_sz)
217 lseek(fd, N_TXTOFF(e), SEEK_SET);
218 size = read_targphys(filename, fd, addr, e.a_text);
221 ret = read_targphys(filename, fd, addr + N_DATADDR(e, target_page_size),
239 static void *load_at(int fd, int offset, int size)
242 if (lseek(fd, offset, SEEK_SET) < 0)
244 ptr = g_malloc(size);
245 if (read(fd, ptr, size) != size) {
256 #define ELF_CLASS ELFCLASS32
260 #define elf_word uint32_t
261 #define elf_sword int32_t
262 #define bswapSZs bswap32s
274 #define elfhdr elf64_hdr
275 #define elf_phdr elf64_phdr
276 #define elf_note elf64_note
277 #define elf_shdr elf64_shdr
278 #define elf_sym elf64_sym
279 #define elf_word uint64_t
280 #define elf_sword int64_t
281 #define bswapSZs bswap64s
285 /* return < 0 if error, otherwise the number of bytes loaded in memory */
286 int load_elf(const char *filename, uint64_t (*translate_fn)(void *, uint64_t),
287 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
288 uint64_t *highaddr, int big_endian, int elf_machine, int clear_lsb)
290 int fd, data_order, target_data_order, must_swab, ret;
291 uint8_t e_ident[EI_NIDENT];
293 fd = open(filename, O_RDONLY | O_BINARY);
298 if (read(fd, e_ident, sizeof(e_ident)) != sizeof(e_ident))
300 if (e_ident[0] != ELFMAG0 ||
301 e_ident[1] != ELFMAG1 ||
302 e_ident[2] != ELFMAG2 ||
303 e_ident[3] != ELFMAG3)
305 #ifdef HOST_WORDS_BIGENDIAN
306 data_order = ELFDATA2MSB;
308 data_order = ELFDATA2LSB;
310 must_swab = data_order != e_ident[EI_DATA];
312 target_data_order = ELFDATA2MSB;
314 target_data_order = ELFDATA2LSB;
317 if (target_data_order != e_ident[EI_DATA]) {
321 lseek(fd, 0, SEEK_SET);
322 if (e_ident[EI_CLASS] == ELFCLASS64) {
323 ret = load_elf64(filename, fd, translate_fn, translate_opaque, must_swab,
324 pentry, lowaddr, highaddr, elf_machine, clear_lsb);
326 ret = load_elf32(filename, fd, translate_fn, translate_opaque, must_swab,
327 pentry, lowaddr, highaddr, elf_machine, clear_lsb);
338 static void bswap_uboot_header(uboot_image_header_t *hdr)
340 #ifndef HOST_WORDS_BIGENDIAN
341 bswap32s(&hdr->ih_magic);
342 bswap32s(&hdr->ih_hcrc);
343 bswap32s(&hdr->ih_time);
344 bswap32s(&hdr->ih_size);
345 bswap32s(&hdr->ih_load);
346 bswap32s(&hdr->ih_ep);
347 bswap32s(&hdr->ih_dcrc);
352 #define ZALLOC_ALIGNMENT 16
354 static void *zalloc(void *x, unsigned items, unsigned size)
359 size = (size + ZALLOC_ALIGNMENT - 1) & ~(ZALLOC_ALIGNMENT - 1);
366 static void zfree(void *x, void *addr)
373 #define EXTRA_FIELD 4
376 #define RESERVED 0xe0
380 /* This is the usual maximum in uboot, so if a uImage overflows this, it would
381 * overflow on real hardware too. */
382 #define UBOOT_MAX_GUNZIP_BYTES (64 << 20)
384 static ssize_t gunzip(void *dst, size_t dstlen, uint8_t *src,
394 if (src[2] != DEFLATED || (flags & RESERVED) != 0) {
395 puts ("Error: Bad gzipped data\n");
398 if ((flags & EXTRA_FIELD) != 0)
399 i = 12 + src[10] + (src[11] << 8);
400 if ((flags & ORIG_NAME) != 0)
401 while (src[i++] != 0)
403 if ((flags & COMMENT) != 0)
404 while (src[i++] != 0)
406 if ((flags & HEAD_CRC) != 0)
409 puts ("Error: gunzip out of data in header\n");
416 r = inflateInit2(&s, -MAX_WBITS);
418 printf ("Error: inflateInit2() returned %d\n", r);
422 s.avail_in = srclen - i;
424 s.avail_out = dstlen;
425 r = inflate(&s, Z_FINISH);
426 if (r != Z_OK && r != Z_STREAM_END) {
427 printf ("Error: inflate() returned %d\n", r);
430 dstbytes = s.next_out - (unsigned char *) dst;
436 /* Load a U-Boot image. */
437 int load_uimage(const char *filename, hwaddr *ep,
438 hwaddr *loadaddr, int *is_linux)
442 uboot_image_header_t h;
443 uboot_image_header_t *hdr = &h;
444 uint8_t *data = NULL;
447 fd = open(filename, O_RDONLY | O_BINARY);
451 size = read(fd, hdr, sizeof(uboot_image_header_t));
455 bswap_uboot_header(hdr);
457 if (hdr->ih_magic != IH_MAGIC)
460 /* TODO: Implement other image types. */
461 if (hdr->ih_type != IH_TYPE_KERNEL) {
462 fprintf(stderr, "Can only load u-boot image type \"kernel\"\n");
466 switch (hdr->ih_comp) {
472 "Unable to load u-boot images with compression type %d\n",
477 /* TODO: Check CPU type. */
479 if (hdr->ih_os == IH_OS_LINUX)
486 data = g_malloc(hdr->ih_size);
488 if (read(fd, data, hdr->ih_size) != hdr->ih_size) {
489 fprintf(stderr, "Error reading file\n");
493 if (hdr->ih_comp == IH_COMP_GZIP) {
494 uint8_t *compressed_data;
498 compressed_data = data;
499 max_bytes = UBOOT_MAX_GUNZIP_BYTES;
500 data = g_malloc(max_bytes);
502 bytes = gunzip(data, max_bytes, compressed_data, hdr->ih_size);
503 g_free(compressed_data);
505 fprintf(stderr, "Unable to decompress gzipped image!\n");
508 hdr->ih_size = bytes;
511 rom_add_blob_fixed(filename, data, hdr->ih_size, hdr->ih_load);
514 *loadaddr = hdr->ih_load;
526 * Functions for reboot-persistent memory regions.
527 * - used for vga bios and option roms.
528 * - also linux kernel (-kernel / -initrd).
531 typedef struct Rom Rom;
543 QTAILQ_ENTRY(Rom) next;
546 static FWCfgState *fw_cfg;
547 static QTAILQ_HEAD(, Rom) roms = QTAILQ_HEAD_INITIALIZER(roms);
549 static void rom_insert(Rom *rom)
554 hw_error ("ROM images must be loaded at startup\n");
557 /* list is ordered by load address */
558 QTAILQ_FOREACH(item, &roms, next) {
559 if (rom->addr >= item->addr)
561 QTAILQ_INSERT_BEFORE(item, rom, next);
564 QTAILQ_INSERT_TAIL(&roms, rom, next);
567 int rom_add_file(const char *file, const char *fw_dir,
568 hwaddr addr, int32_t bootindex)
574 rom = g_malloc0(sizeof(*rom));
575 rom->name = g_strdup(file);
576 rom->path = qemu_find_file(QEMU_FILE_TYPE_BIOS, rom->name);
577 if (rom->path == NULL) {
578 rom->path = g_strdup(file);
581 fd = open(rom->path, O_RDONLY | O_BINARY);
583 fprintf(stderr, "Could not open option rom '%s': %s\n",
584 rom->path, strerror(errno));
589 rom->fw_dir = g_strdup(fw_dir);
590 rom->fw_file = g_strdup(file);
593 rom->romsize = lseek(fd, 0, SEEK_END);
594 rom->data = g_malloc0(rom->romsize);
595 lseek(fd, 0, SEEK_SET);
596 rc = read(fd, rom->data, rom->romsize);
597 if (rc != rom->romsize) {
598 fprintf(stderr, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
599 rom->name, rc, rom->romsize);
604 if (rom->fw_file && fw_cfg) {
605 const char *basename;
606 char fw_file_name[56];
608 basename = strrchr(rom->fw_file, '/');
612 basename = rom->fw_file;
614 snprintf(fw_file_name, sizeof(fw_file_name), "%s/%s", rom->fw_dir,
616 fw_cfg_add_file(fw_cfg, fw_file_name, rom->data, rom->romsize);
617 snprintf(devpath, sizeof(devpath), "/rom@%s", fw_file_name);
619 snprintf(devpath, sizeof(devpath), "/rom@" TARGET_FMT_plx, addr);
622 add_boot_device_path(bootindex, NULL, devpath);
635 int rom_add_blob(const char *name, const void *blob, size_t len,
640 rom = g_malloc0(sizeof(*rom));
641 rom->name = g_strdup(name);
644 rom->data = g_malloc0(rom->romsize);
645 memcpy(rom->data, blob, len);
650 int rom_add_vga(const char *file)
652 return rom_add_file(file, "vgaroms", 0, -1);
655 int rom_add_option(const char *file, int32_t bootindex)
657 return rom_add_file(file, "genroms", 0, bootindex);
660 static void rom_reset(void *unused)
664 QTAILQ_FOREACH(rom, &roms, next) {
668 if (rom->data == NULL) {
671 cpu_physical_memory_write_rom(rom->addr, rom->data, rom->romsize);
673 /* rom needs to be written only once */
680 int rom_load_all(void)
683 MemoryRegionSection section;
686 QTAILQ_FOREACH(rom, &roms, next) {
690 if (addr > rom->addr) {
691 fprintf(stderr, "rom: requested regions overlap "
692 "(rom %s. free=0x" TARGET_FMT_plx
693 ", addr=0x" TARGET_FMT_plx ")\n",
694 rom->name, addr, rom->addr);
698 addr += rom->romsize;
699 section = memory_region_find(get_system_memory(), rom->addr, 1);
700 rom->isrom = section.size && memory_region_is_rom(section.mr);
702 qemu_register_reset(rom_reset, NULL);
707 void rom_set_fw(void *f)
712 static Rom *find_rom(hwaddr addr)
716 QTAILQ_FOREACH(rom, &roms, next) {
720 if (rom->addr > addr) {
723 if (rom->addr + rom->romsize < addr) {
732 * Copies memory from registered ROMs to dest. Any memory that is contained in
733 * a ROM between addr and addr + size is copied. Note that this can involve
734 * multiple ROMs, which need not start at addr and need not end at addr + size.
736 int rom_copy(uint8_t *dest, hwaddr addr, size_t size)
738 hwaddr end = addr + size;
739 uint8_t *s, *d = dest;
743 QTAILQ_FOREACH(rom, &roms, next) {
747 if (rom->addr + rom->romsize < addr) {
750 if (rom->addr > end) {
757 d = dest + (rom->addr - addr);
761 if ((d + l) > (dest + size)) {
768 return (d + l) - dest;
771 void *rom_ptr(hwaddr addr)
775 rom = find_rom(addr);
776 if (!rom || !rom->data)
778 return rom->data + (addr - rom->addr);
781 void do_info_roms(Monitor *mon)
785 QTAILQ_FOREACH(rom, &roms, next) {
787 monitor_printf(mon, "addr=" TARGET_FMT_plx
788 " size=0x%06zx mem=%s name=\"%s\"\n",
789 rom->addr, rom->romsize,
790 rom->isrom ? "rom" : "ram",
793 monitor_printf(mon, "fw=%s/%s"
794 " size=0x%06zx name=\"%s\"\n",