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"
47 #include "monitor/monitor.h"
48 #include "sysemu/sysemu.h"
49 #include "uboot_image.h"
50 #include "hw/loader.h"
51 #include "hw/nvram/fw_cfg.h"
52 #include "exec/memory.h"
53 #include "exec/address-spaces.h"
57 bool rom_file_has_mr
= true;
59 static int roms_loaded
;
61 /* return the size or -1 if error */
62 int get_image_size(const char *filename
)
65 fd
= open(filename
, O_RDONLY
| O_BINARY
);
68 size
= lseek(fd
, 0, SEEK_END
);
73 /* return the size or -1 if error */
74 /* deprecated, because caller does not specify buffer size! */
75 int load_image(const char *filename
, uint8_t *addr
)
78 fd
= open(filename
, O_RDONLY
| O_BINARY
);
81 size
= lseek(fd
, 0, SEEK_END
);
82 lseek(fd
, 0, SEEK_SET
);
83 if (read(fd
, addr
, size
) != size
) {
91 /* read()-like version */
92 ssize_t
read_targphys(const char *name
,
93 int fd
, hwaddr dst_addr
, size_t nbytes
)
98 buf
= g_malloc(nbytes
);
99 did
= read(fd
, buf
, nbytes
);
101 rom_add_blob_fixed("read", buf
, did
, dst_addr
);
106 /* return the size or -1 if error */
107 int load_image_targphys(const char *filename
,
108 hwaddr addr
, uint64_t max_sz
)
112 size
= get_image_size(filename
);
117 rom_add_file_fixed(filename
, addr
, -1);
122 void pstrcpy_targphys(const char *name
, hwaddr dest
, int buf_size
,
128 if (buf_size
<= 0) return;
129 nulp
= memchr(source
, 0, buf_size
);
131 rom_add_blob_fixed(name
, source
, (nulp
- source
) + 1, dest
);
133 rom_add_blob_fixed(name
, source
, buf_size
, dest
);
134 ptr
= rom_ptr(dest
+ buf_size
- 1);
143 uint32_t a_info
; /* Use macros N_MAGIC, etc for access */
144 uint32_t a_text
; /* length of text, in bytes */
145 uint32_t a_data
; /* length of data, in bytes */
146 uint32_t a_bss
; /* length of uninitialized data area, in bytes */
147 uint32_t a_syms
; /* length of symbol table data in file, in bytes */
148 uint32_t a_entry
; /* start address */
149 uint32_t a_trsize
; /* length of relocation info for text, in bytes */
150 uint32_t a_drsize
; /* length of relocation info for data, in bytes */
153 static void bswap_ahdr(struct exec
*e
)
155 bswap32s(&e
->a_info
);
156 bswap32s(&e
->a_text
);
157 bswap32s(&e
->a_data
);
159 bswap32s(&e
->a_syms
);
160 bswap32s(&e
->a_entry
);
161 bswap32s(&e
->a_trsize
);
162 bswap32s(&e
->a_drsize
);
165 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
170 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
171 #define N_TXTOFF(x) \
172 (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) : \
173 (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
174 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
175 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
177 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
179 #define N_DATADDR(x, target_page_size) \
180 (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
181 : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
184 int load_aout(const char *filename
, hwaddr addr
, int max_sz
,
185 int bswap_needed
, hwaddr target_page_size
)
192 fd
= open(filename
, O_RDONLY
| O_BINARY
);
196 size
= read(fd
, &e
, sizeof(e
));
209 if (e
.a_text
+ e
.a_data
> max_sz
)
211 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
212 size
= read_targphys(filename
, fd
, addr
, e
.a_text
+ e
.a_data
);
217 if (N_DATADDR(e
, target_page_size
) + e
.a_data
> max_sz
)
219 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
220 size
= read_targphys(filename
, fd
, addr
, e
.a_text
);
223 ret
= read_targphys(filename
, fd
, addr
+ N_DATADDR(e
, target_page_size
),
241 static void *load_at(int fd
, int offset
, int size
)
244 if (lseek(fd
, offset
, SEEK_SET
) < 0)
246 ptr
= g_malloc(size
);
247 if (read(fd
, ptr
, size
) != size
) {
258 #define ELF_CLASS ELFCLASS32
262 #define elf_word uint32_t
263 #define elf_sword int32_t
264 #define bswapSZs bswap32s
265 #include "hw/elf_ops.h"
276 #define elfhdr elf64_hdr
277 #define elf_phdr elf64_phdr
278 #define elf_note elf64_note
279 #define elf_shdr elf64_shdr
280 #define elf_sym elf64_sym
281 #define elf_word uint64_t
282 #define elf_sword int64_t
283 #define bswapSZs bswap64s
285 #include "hw/elf_ops.h"
287 const char *load_elf_strerror(int error
)
292 case ELF_LOAD_FAILED
:
293 return "Failed to load ELF";
294 case ELF_LOAD_NOT_ELF
:
295 return "The image is not ELF";
296 case ELF_LOAD_WRONG_ARCH
:
297 return "The image is from incompatible architecture";
298 case ELF_LOAD_WRONG_ENDIAN
:
299 return "The image has incorrect endianness";
301 return "Unknown error";
305 /* return < 0 if error, otherwise the number of bytes loaded in memory */
306 int load_elf(const char *filename
, uint64_t (*translate_fn
)(void *, uint64_t),
307 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
308 uint64_t *highaddr
, int big_endian
, int elf_machine
, int clear_lsb
)
310 int fd
, data_order
, target_data_order
, must_swab
, ret
= ELF_LOAD_FAILED
;
311 uint8_t e_ident
[EI_NIDENT
];
313 fd
= open(filename
, O_RDONLY
| O_BINARY
);
318 if (read(fd
, e_ident
, sizeof(e_ident
)) != sizeof(e_ident
))
320 if (e_ident
[0] != ELFMAG0
||
321 e_ident
[1] != ELFMAG1
||
322 e_ident
[2] != ELFMAG2
||
323 e_ident
[3] != ELFMAG3
) {
324 ret
= ELF_LOAD_NOT_ELF
;
327 #ifdef HOST_WORDS_BIGENDIAN
328 data_order
= ELFDATA2MSB
;
330 data_order
= ELFDATA2LSB
;
332 must_swab
= data_order
!= e_ident
[EI_DATA
];
334 target_data_order
= ELFDATA2MSB
;
336 target_data_order
= ELFDATA2LSB
;
339 if (target_data_order
!= e_ident
[EI_DATA
]) {
340 ret
= ELF_LOAD_WRONG_ENDIAN
;
344 lseek(fd
, 0, SEEK_SET
);
345 if (e_ident
[EI_CLASS
] == ELFCLASS64
) {
346 ret
= load_elf64(filename
, fd
, translate_fn
, translate_opaque
, must_swab
,
347 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
);
349 ret
= load_elf32(filename
, fd
, translate_fn
, translate_opaque
, must_swab
,
350 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
);
358 static void bswap_uboot_header(uboot_image_header_t
*hdr
)
360 #ifndef HOST_WORDS_BIGENDIAN
361 bswap32s(&hdr
->ih_magic
);
362 bswap32s(&hdr
->ih_hcrc
);
363 bswap32s(&hdr
->ih_time
);
364 bswap32s(&hdr
->ih_size
);
365 bswap32s(&hdr
->ih_load
);
366 bswap32s(&hdr
->ih_ep
);
367 bswap32s(&hdr
->ih_dcrc
);
372 #define ZALLOC_ALIGNMENT 16
374 static void *zalloc(void *x
, unsigned items
, unsigned size
)
379 size
= (size
+ ZALLOC_ALIGNMENT
- 1) & ~(ZALLOC_ALIGNMENT
- 1);
386 static void zfree(void *x
, void *addr
)
393 #define EXTRA_FIELD 4
396 #define RESERVED 0xe0
400 /* This is the usual maximum in uboot, so if a uImage overflows this, it would
401 * overflow on real hardware too. */
402 #define UBOOT_MAX_GUNZIP_BYTES (64 << 20)
404 static ssize_t
gunzip(void *dst
, size_t dstlen
, uint8_t *src
,
414 if (src
[2] != DEFLATED
|| (flags
& RESERVED
) != 0) {
415 puts ("Error: Bad gzipped data\n");
418 if ((flags
& EXTRA_FIELD
) != 0)
419 i
= 12 + src
[10] + (src
[11] << 8);
420 if ((flags
& ORIG_NAME
) != 0)
421 while (src
[i
++] != 0)
423 if ((flags
& COMMENT
) != 0)
424 while (src
[i
++] != 0)
426 if ((flags
& HEAD_CRC
) != 0)
429 puts ("Error: gunzip out of data in header\n");
436 r
= inflateInit2(&s
, -MAX_WBITS
);
438 printf ("Error: inflateInit2() returned %d\n", r
);
442 s
.avail_in
= srclen
- i
;
444 s
.avail_out
= dstlen
;
445 r
= inflate(&s
, Z_FINISH
);
446 if (r
!= Z_OK
&& r
!= Z_STREAM_END
) {
447 printf ("Error: inflate() returned %d\n", r
);
450 dstbytes
= s
.next_out
- (unsigned char *) dst
;
456 /* Load a U-Boot image. */
457 static int load_uboot_image(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
458 int *is_linux
, uint8_t image_type
)
463 uboot_image_header_t h
;
464 uboot_image_header_t
*hdr
= &h
;
465 uint8_t *data
= NULL
;
467 int do_uncompress
= 0;
469 fd
= open(filename
, O_RDONLY
| O_BINARY
);
473 size
= read(fd
, hdr
, sizeof(uboot_image_header_t
));
477 bswap_uboot_header(hdr
);
479 if (hdr
->ih_magic
!= IH_MAGIC
)
482 if (hdr
->ih_type
!= image_type
) {
483 fprintf(stderr
, "Wrong image type %d, expected %d\n", hdr
->ih_type
,
488 /* TODO: Implement other image types. */
489 switch (hdr
->ih_type
) {
491 address
= hdr
->ih_load
;
493 *loadaddr
= hdr
->ih_load
;
496 switch (hdr
->ih_comp
) {
504 "Unable to load u-boot images with compression type %d\n",
513 /* TODO: Check CPU type. */
515 if (hdr
->ih_os
== IH_OS_LINUX
) {
523 case IH_TYPE_RAMDISK
:
527 fprintf(stderr
, "Unsupported u-boot image type %d\n", hdr
->ih_type
);
531 data
= g_malloc(hdr
->ih_size
);
533 if (read(fd
, data
, hdr
->ih_size
) != hdr
->ih_size
) {
534 fprintf(stderr
, "Error reading file\n");
539 uint8_t *compressed_data
;
543 compressed_data
= data
;
544 max_bytes
= UBOOT_MAX_GUNZIP_BYTES
;
545 data
= g_malloc(max_bytes
);
547 bytes
= gunzip(data
, max_bytes
, compressed_data
, hdr
->ih_size
);
548 g_free(compressed_data
);
550 fprintf(stderr
, "Unable to decompress gzipped image!\n");
553 hdr
->ih_size
= bytes
;
556 rom_add_blob_fixed(filename
, data
, hdr
->ih_size
, address
);
567 int load_uimage(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
570 return load_uboot_image(filename
, ep
, loadaddr
, is_linux
, IH_TYPE_KERNEL
);
573 /* Load a ramdisk. */
574 int load_ramdisk(const char *filename
, hwaddr addr
, uint64_t max_sz
)
576 return load_uboot_image(filename
, NULL
, &addr
, NULL
, IH_TYPE_RAMDISK
);
580 * Functions for reboot-persistent memory regions.
581 * - used for vga bios and option roms.
582 * - also linux kernel (-kernel / -initrd).
585 typedef struct Rom Rom
;
591 /* datasize is the amount of memory allocated in "data". If datasize is less
592 * than romsize, it means that the area from datasize to romsize is filled
605 QTAILQ_ENTRY(Rom
) next
;
608 static FWCfgState
*fw_cfg
;
609 static QTAILQ_HEAD(, Rom
) roms
= QTAILQ_HEAD_INITIALIZER(roms
);
611 static void rom_insert(Rom
*rom
)
616 hw_error ("ROM images must be loaded at startup\n");
619 /* list is ordered by load address */
620 QTAILQ_FOREACH(item
, &roms
, next
) {
621 if (rom
->addr
>= item
->addr
)
623 QTAILQ_INSERT_BEFORE(item
, rom
, next
);
626 QTAILQ_INSERT_TAIL(&roms
, rom
, next
);
629 static void *rom_set_mr(Rom
*rom
, Object
*owner
, const char *name
)
633 rom
->mr
= g_malloc(sizeof(*rom
->mr
));
634 memory_region_init_ram(rom
->mr
, owner
, name
, rom
->datasize
);
635 memory_region_set_readonly(rom
->mr
, true);
636 vmstate_register_ram_global(rom
->mr
);
638 data
= memory_region_get_ram_ptr(rom
->mr
);
639 memcpy(data
, rom
->data
, rom
->datasize
);
644 int rom_add_file(const char *file
, const char *fw_dir
,
645 hwaddr addr
, int32_t bootindex
)
651 rom
= g_malloc0(sizeof(*rom
));
652 rom
->name
= g_strdup(file
);
653 rom
->path
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, rom
->name
);
654 if (rom
->path
== NULL
) {
655 rom
->path
= g_strdup(file
);
658 fd
= open(rom
->path
, O_RDONLY
| O_BINARY
);
660 fprintf(stderr
, "Could not open option rom '%s': %s\n",
661 rom
->path
, strerror(errno
));
666 rom
->fw_dir
= g_strdup(fw_dir
);
667 rom
->fw_file
= g_strdup(file
);
670 rom
->romsize
= lseek(fd
, 0, SEEK_END
);
671 rom
->datasize
= rom
->romsize
;
672 rom
->data
= g_malloc0(rom
->datasize
);
673 lseek(fd
, 0, SEEK_SET
);
674 rc
= read(fd
, rom
->data
, rom
->datasize
);
675 if (rc
!= rom
->datasize
) {
676 fprintf(stderr
, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
677 rom
->name
, rc
, rom
->datasize
);
682 if (rom
->fw_file
&& fw_cfg
) {
683 const char *basename
;
684 char fw_file_name
[FW_CFG_MAX_FILE_PATH
];
687 basename
= strrchr(rom
->fw_file
, '/');
691 basename
= rom
->fw_file
;
693 snprintf(fw_file_name
, sizeof(fw_file_name
), "%s/%s", rom
->fw_dir
,
695 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
697 if (rom_file_has_mr
) {
698 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
);
703 fw_cfg_add_file(fw_cfg
, fw_file_name
, data
, rom
->romsize
);
705 snprintf(devpath
, sizeof(devpath
), "/rom@" TARGET_FMT_plx
, addr
);
708 add_boot_device_path(bootindex
, NULL
, devpath
);
721 void *rom_add_blob(const char *name
, const void *blob
, size_t len
,
722 hwaddr addr
, const char *fw_file_name
,
723 FWCfgReadCallback fw_callback
, void *callback_opaque
)
728 rom
= g_malloc0(sizeof(*rom
));
729 rom
->name
= g_strdup(name
);
733 rom
->data
= g_malloc0(rom
->datasize
);
734 memcpy(rom
->data
, blob
, len
);
736 if (fw_file_name
&& fw_cfg
) {
739 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
741 if (rom_file_has_mr
) {
742 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
);
747 fw_cfg_add_file_callback(fw_cfg
, fw_file_name
,
748 fw_callback
, callback_opaque
,
754 /* This function is specific for elf program because we don't need to allocate
755 * all the rom. We just allocate the first part and the rest is just zeros. This
756 * is why romsize and datasize are different. Also, this function seize the
757 * memory ownership of "data", so we don't have to allocate and copy the buffer.
759 int rom_add_elf_program(const char *name
, void *data
, size_t datasize
,
760 size_t romsize
, hwaddr addr
)
764 rom
= g_malloc0(sizeof(*rom
));
765 rom
->name
= g_strdup(name
);
767 rom
->datasize
= datasize
;
768 rom
->romsize
= romsize
;
774 int rom_add_vga(const char *file
)
776 return rom_add_file(file
, "vgaroms", 0, -1);
779 int rom_add_option(const char *file
, int32_t bootindex
)
781 return rom_add_file(file
, "genroms", 0, bootindex
);
784 static void rom_reset(void *unused
)
788 QTAILQ_FOREACH(rom
, &roms
, next
) {
792 if (rom
->data
== NULL
) {
796 void *host
= memory_region_get_ram_ptr(rom
->mr
);
797 memcpy(host
, rom
->data
, rom
->datasize
);
799 cpu_physical_memory_write_rom(&address_space_memory
,
800 rom
->addr
, rom
->data
, rom
->datasize
);
803 /* rom needs to be written only once */
808 * The rom loader is really on the same level as firmware in the guest
809 * shadowing a ROM into RAM. Such a shadowing mechanism needs to ensure
810 * that the instruction cache for that new region is clear, so that the
811 * CPU definitely fetches its instructions from the just written data.
813 cpu_flush_icache_range(rom
->addr
, rom
->datasize
);
817 int rom_load_all(void)
820 MemoryRegionSection section
;
823 QTAILQ_FOREACH(rom
, &roms
, next
) {
827 if (addr
> rom
->addr
) {
828 fprintf(stderr
, "rom: requested regions overlap "
829 "(rom %s. free=0x" TARGET_FMT_plx
830 ", addr=0x" TARGET_FMT_plx
")\n",
831 rom
->name
, addr
, rom
->addr
);
835 addr
+= rom
->romsize
;
836 section
= memory_region_find(get_system_memory(), rom
->addr
, 1);
837 rom
->isrom
= int128_nz(section
.size
) && memory_region_is_rom(section
.mr
);
838 memory_region_unref(section
.mr
);
840 qemu_register_reset(rom_reset
, NULL
);
844 void rom_load_done(void)
849 void rom_set_fw(FWCfgState
*f
)
854 static Rom
*find_rom(hwaddr addr
)
858 QTAILQ_FOREACH(rom
, &roms
, next
) {
865 if (rom
->addr
> addr
) {
868 if (rom
->addr
+ rom
->romsize
< addr
) {
877 * Copies memory from registered ROMs to dest. Any memory that is contained in
878 * a ROM between addr and addr + size is copied. Note that this can involve
879 * multiple ROMs, which need not start at addr and need not end at addr + size.
881 int rom_copy(uint8_t *dest
, hwaddr addr
, size_t size
)
883 hwaddr end
= addr
+ size
;
884 uint8_t *s
, *d
= dest
;
888 QTAILQ_FOREACH(rom
, &roms
, next
) {
895 if (rom
->addr
+ rom
->romsize
< addr
) {
898 if (rom
->addr
> end
) {
902 d
= dest
+ (rom
->addr
- addr
);
906 if ((d
+ l
) > (dest
+ size
)) {
914 if (rom
->romsize
> rom
->datasize
) {
915 /* If datasize is less than romsize, it means that we didn't
916 * allocate all the ROM because the trailing data are only zeros.
920 l
= rom
->romsize
- rom
->datasize
;
922 if ((d
+ l
) > (dest
+ size
)) {
923 /* Rom size doesn't fit in the destination area. Adjust to avoid
935 return (d
+ l
) - dest
;
938 void *rom_ptr(hwaddr addr
)
942 rom
= find_rom(addr
);
943 if (!rom
|| !rom
->data
)
945 return rom
->data
+ (addr
- rom
->addr
);
948 void do_info_roms(Monitor
*mon
, const QDict
*qdict
)
952 QTAILQ_FOREACH(rom
, &roms
, next
) {
954 monitor_printf(mon
, "%s"
955 " size=0x%06zx name=\"%s\"\n",
959 } else if (!rom
->fw_file
) {
960 monitor_printf(mon
, "addr=" TARGET_FMT_plx
961 " size=0x%06zx mem=%s name=\"%s\"\n",
962 rom
->addr
, rom
->romsize
,
963 rom
->isrom
? "rom" : "ram",
966 monitor_printf(mon
, "fw=%s/%s"
967 " size=0x%06zx name=\"%s\"\n",