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/>.
49 #include "uboot_image.h"
55 static int roms_loaded
;
57 /* return the size or -1 if error */
58 int get_image_size(const char *filename
)
61 fd
= open(filename
, O_RDONLY
| O_BINARY
);
64 size
= lseek(fd
, 0, SEEK_END
);
69 /* return the size or -1 if error */
70 /* deprecated, because caller does not specify buffer size! */
71 int load_image(const char *filename
, uint8_t *addr
)
74 fd
= open(filename
, O_RDONLY
| O_BINARY
);
77 size
= lseek(fd
, 0, SEEK_END
);
78 lseek(fd
, 0, SEEK_SET
);
79 if (read(fd
, addr
, size
) != size
) {
87 /* read()-like version */
88 int read_targphys(const char *name
,
89 int fd
, target_phys_addr_t dst_addr
, size_t nbytes
)
94 buf
= g_malloc(nbytes
);
95 did
= read(fd
, buf
, nbytes
);
97 rom_add_blob_fixed("read", buf
, did
, dst_addr
);
102 /* return the size or -1 if error */
103 int load_image_targphys(const char *filename
,
104 target_phys_addr_t addr
, int max_sz
)
108 size
= get_image_size(filename
);
110 rom_add_file_fixed(filename
, addr
, -1);
114 void pstrcpy_targphys(const char *name
, target_phys_addr_t dest
, int buf_size
,
120 if (buf_size
<= 0) return;
121 nulp
= memchr(source
, 0, buf_size
);
123 rom_add_blob_fixed(name
, source
, (nulp
- source
) + 1, dest
);
125 rom_add_blob_fixed(name
, source
, buf_size
, dest
);
126 ptr
= rom_ptr(dest
+ buf_size
- 1);
135 uint32_t a_info
; /* Use macros N_MAGIC, etc for access */
136 uint32_t a_text
; /* length of text, in bytes */
137 uint32_t a_data
; /* length of data, in bytes */
138 uint32_t a_bss
; /* length of uninitialized data area, in bytes */
139 uint32_t a_syms
; /* length of symbol table data in file, in bytes */
140 uint32_t a_entry
; /* start address */
141 uint32_t a_trsize
; /* length of relocation info for text, in bytes */
142 uint32_t a_drsize
; /* length of relocation info for data, in bytes */
145 static void bswap_ahdr(struct exec
*e
)
147 bswap32s(&e
->a_info
);
148 bswap32s(&e
->a_text
);
149 bswap32s(&e
->a_data
);
151 bswap32s(&e
->a_syms
);
152 bswap32s(&e
->a_entry
);
153 bswap32s(&e
->a_trsize
);
154 bswap32s(&e
->a_drsize
);
157 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
162 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
163 #define N_TXTOFF(x) \
164 (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) : \
165 (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
166 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
167 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
169 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
171 #define N_DATADDR(x, target_page_size) \
172 (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
173 : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
176 int load_aout(const char *filename
, target_phys_addr_t addr
, int max_sz
,
177 int bswap_needed
, target_phys_addr_t target_page_size
)
183 fd
= open(filename
, O_RDONLY
| O_BINARY
);
187 size
= read(fd
, &e
, sizeof(e
));
200 if (e
.a_text
+ e
.a_data
> max_sz
)
202 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
203 size
= read_targphys(filename
, fd
, addr
, e
.a_text
+ e
.a_data
);
208 if (N_DATADDR(e
, target_page_size
) + e
.a_data
> max_sz
)
210 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
211 size
= read_targphys(filename
, fd
, addr
, e
.a_text
);
214 ret
= read_targphys(filename
, fd
, addr
+ N_DATADDR(e
, target_page_size
),
232 static void *load_at(int fd
, int offset
, int size
)
235 if (lseek(fd
, offset
, SEEK_SET
) < 0)
237 ptr
= g_malloc(size
);
238 if (read(fd
, ptr
, size
) != size
) {
249 #define ELF_CLASS ELFCLASS32
253 #define elf_word uint32_t
254 #define elf_sword int32_t
255 #define bswapSZs bswap32s
267 #define elfhdr elf64_hdr
268 #define elf_phdr elf64_phdr
269 #define elf_note elf64_note
270 #define elf_shdr elf64_shdr
271 #define elf_sym elf64_sym
272 #define elf_word uint64_t
273 #define elf_sword int64_t
274 #define bswapSZs bswap64s
278 /* return < 0 if error, otherwise the number of bytes loaded in memory */
279 int load_elf(const char *filename
, uint64_t (*translate_fn
)(void *, uint64_t),
280 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
281 uint64_t *highaddr
, int big_endian
, int elf_machine
, int clear_lsb
)
283 int fd
, data_order
, target_data_order
, must_swab
, ret
;
284 uint8_t e_ident
[EI_NIDENT
];
286 fd
= open(filename
, O_RDONLY
| O_BINARY
);
291 if (read(fd
, e_ident
, sizeof(e_ident
)) != sizeof(e_ident
))
293 if (e_ident
[0] != ELFMAG0
||
294 e_ident
[1] != ELFMAG1
||
295 e_ident
[2] != ELFMAG2
||
296 e_ident
[3] != ELFMAG3
)
298 #ifdef HOST_WORDS_BIGENDIAN
299 data_order
= ELFDATA2MSB
;
301 data_order
= ELFDATA2LSB
;
303 must_swab
= data_order
!= e_ident
[EI_DATA
];
305 target_data_order
= ELFDATA2MSB
;
307 target_data_order
= ELFDATA2LSB
;
310 if (target_data_order
!= e_ident
[EI_DATA
]) {
314 lseek(fd
, 0, SEEK_SET
);
315 if (e_ident
[EI_CLASS
] == ELFCLASS64
) {
316 ret
= load_elf64(filename
, fd
, translate_fn
, translate_opaque
, must_swab
,
317 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
);
319 ret
= load_elf32(filename
, fd
, translate_fn
, translate_opaque
, must_swab
,
320 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
);
331 static void bswap_uboot_header(uboot_image_header_t
*hdr
)
333 #ifndef HOST_WORDS_BIGENDIAN
334 bswap32s(&hdr
->ih_magic
);
335 bswap32s(&hdr
->ih_hcrc
);
336 bswap32s(&hdr
->ih_time
);
337 bswap32s(&hdr
->ih_size
);
338 bswap32s(&hdr
->ih_load
);
339 bswap32s(&hdr
->ih_ep
);
340 bswap32s(&hdr
->ih_dcrc
);
345 #define ZALLOC_ALIGNMENT 16
347 static void *zalloc(void *x
, unsigned items
, unsigned size
)
352 size
= (size
+ ZALLOC_ALIGNMENT
- 1) & ~(ZALLOC_ALIGNMENT
- 1);
359 static void zfree(void *x
, void *addr
)
366 #define EXTRA_FIELD 4
369 #define RESERVED 0xe0
373 /* This is the maximum in uboot, so if a uImage overflows this, it would
374 * overflow on real hardware too. */
375 #define UBOOT_MAX_GUNZIP_BYTES 0x800000
377 static ssize_t
gunzip(void *dst
, size_t dstlen
, uint8_t *src
,
387 if (src
[2] != DEFLATED
|| (flags
& RESERVED
) != 0) {
388 puts ("Error: Bad gzipped data\n");
391 if ((flags
& EXTRA_FIELD
) != 0)
392 i
= 12 + src
[10] + (src
[11] << 8);
393 if ((flags
& ORIG_NAME
) != 0)
394 while (src
[i
++] != 0)
396 if ((flags
& COMMENT
) != 0)
397 while (src
[i
++] != 0)
399 if ((flags
& HEAD_CRC
) != 0)
402 puts ("Error: gunzip out of data in header\n");
409 r
= inflateInit2(&s
, -MAX_WBITS
);
411 printf ("Error: inflateInit2() returned %d\n", r
);
415 s
.avail_in
= srclen
- i
;
417 s
.avail_out
= dstlen
;
418 r
= inflate(&s
, Z_FINISH
);
419 if (r
!= Z_OK
&& r
!= Z_STREAM_END
) {
420 printf ("Error: inflate() returned %d\n", r
);
423 dstbytes
= s
.next_out
- (unsigned char *) dst
;
429 /* Load a U-Boot image. */
430 int load_uimage(const char *filename
, target_phys_addr_t
*ep
,
431 target_phys_addr_t
*loadaddr
, int *is_linux
)
435 uboot_image_header_t h
;
436 uboot_image_header_t
*hdr
= &h
;
437 uint8_t *data
= NULL
;
440 fd
= open(filename
, O_RDONLY
| O_BINARY
);
444 size
= read(fd
, hdr
, sizeof(uboot_image_header_t
));
448 bswap_uboot_header(hdr
);
450 if (hdr
->ih_magic
!= IH_MAGIC
)
453 /* TODO: Implement other image types. */
454 if (hdr
->ih_type
!= IH_TYPE_KERNEL
) {
455 fprintf(stderr
, "Can only load u-boot image type \"kernel\"\n");
459 switch (hdr
->ih_comp
) {
465 "Unable to load u-boot images with compression type %d\n",
470 /* TODO: Check CPU type. */
472 if (hdr
->ih_os
== IH_OS_LINUX
)
479 data
= g_malloc(hdr
->ih_size
);
481 if (read(fd
, data
, hdr
->ih_size
) != hdr
->ih_size
) {
482 fprintf(stderr
, "Error reading file\n");
486 if (hdr
->ih_comp
== IH_COMP_GZIP
) {
487 uint8_t *compressed_data
;
491 compressed_data
= data
;
492 max_bytes
= UBOOT_MAX_GUNZIP_BYTES
;
493 data
= g_malloc(max_bytes
);
495 bytes
= gunzip(data
, max_bytes
, compressed_data
, hdr
->ih_size
);
496 g_free(compressed_data
);
498 fprintf(stderr
, "Unable to decompress gzipped image!\n");
501 hdr
->ih_size
= bytes
;
504 rom_add_blob_fixed(filename
, data
, hdr
->ih_size
, hdr
->ih_load
);
507 *loadaddr
= hdr
->ih_load
;
519 * Functions for reboot-persistent memory regions.
520 * - used for vga bios and option roms.
521 * - also linux kernel (-kernel / -initrd).
524 typedef struct Rom Rom
;
535 target_phys_addr_t addr
;
536 QTAILQ_ENTRY(Rom
) next
;
539 static FWCfgState
*fw_cfg
;
540 static QTAILQ_HEAD(, Rom
) roms
= QTAILQ_HEAD_INITIALIZER(roms
);
542 static void rom_insert(Rom
*rom
)
547 hw_error ("ROM images must be loaded at startup\n");
550 /* list is ordered by load address */
551 QTAILQ_FOREACH(item
, &roms
, next
) {
552 if (rom
->addr
>= item
->addr
)
554 QTAILQ_INSERT_BEFORE(item
, rom
, next
);
557 QTAILQ_INSERT_TAIL(&roms
, rom
, next
);
560 int rom_add_file(const char *file
, const char *fw_dir
,
561 target_phys_addr_t addr
, int32_t bootindex
)
567 rom
= g_malloc0(sizeof(*rom
));
568 rom
->name
= g_strdup(file
);
569 rom
->path
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, rom
->name
);
570 if (rom
->path
== NULL
) {
571 rom
->path
= g_strdup(file
);
574 fd
= open(rom
->path
, O_RDONLY
| O_BINARY
);
576 fprintf(stderr
, "Could not open option rom '%s': %s\n",
577 rom
->path
, strerror(errno
));
582 rom
->fw_dir
= g_strdup(fw_dir
);
583 rom
->fw_file
= g_strdup(file
);
586 rom
->romsize
= lseek(fd
, 0, SEEK_END
);
587 rom
->data
= g_malloc0(rom
->romsize
);
588 lseek(fd
, 0, SEEK_SET
);
589 rc
= read(fd
, rom
->data
, rom
->romsize
);
590 if (rc
!= rom
->romsize
) {
591 fprintf(stderr
, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
592 rom
->name
, rc
, rom
->romsize
);
597 if (rom
->fw_file
&& fw_cfg
) {
598 const char *basename
;
599 char fw_file_name
[56];
601 basename
= strrchr(rom
->fw_file
, '/');
605 basename
= rom
->fw_file
;
607 snprintf(fw_file_name
, sizeof(fw_file_name
), "%s/%s", rom
->fw_dir
,
609 fw_cfg_add_file(fw_cfg
, fw_file_name
, rom
->data
, rom
->romsize
);
610 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
612 snprintf(devpath
, sizeof(devpath
), "/rom@" TARGET_FMT_plx
, addr
);
615 add_boot_device_path(bootindex
, NULL
, devpath
);
628 int rom_add_blob(const char *name
, const void *blob
, size_t len
,
629 target_phys_addr_t addr
)
633 rom
= g_malloc0(sizeof(*rom
));
634 rom
->name
= g_strdup(name
);
637 rom
->data
= g_malloc0(rom
->romsize
);
638 memcpy(rom
->data
, blob
, len
);
643 int rom_add_vga(const char *file
)
645 return rom_add_file(file
, "vgaroms", 0, -1);
648 int rom_add_option(const char *file
, int32_t bootindex
)
650 return rom_add_file(file
, "genroms", 0, bootindex
);
653 static void rom_reset(void *unused
)
657 QTAILQ_FOREACH(rom
, &roms
, next
) {
661 if (rom
->data
== NULL
) {
664 cpu_physical_memory_write_rom(rom
->addr
, rom
->data
, rom
->romsize
);
666 /* rom needs to be written only once */
673 int rom_load_all(void)
675 target_phys_addr_t addr
= 0;
679 QTAILQ_FOREACH(rom
, &roms
, next
) {
683 if (addr
> rom
->addr
) {
684 fprintf(stderr
, "rom: requested regions overlap "
685 "(rom %s. free=0x" TARGET_FMT_plx
686 ", addr=0x" TARGET_FMT_plx
")\n",
687 rom
->name
, addr
, rom
->addr
);
691 addr
+= rom
->romsize
;
692 memtype
= cpu_get_physical_page_desc(rom
->addr
) & (3 << IO_MEM_SHIFT
);
693 if (memtype
== IO_MEM_ROM
)
696 qemu_register_reset(rom_reset
, NULL
);
701 void rom_set_fw(void *f
)
706 static Rom
*find_rom(target_phys_addr_t addr
)
710 QTAILQ_FOREACH(rom
, &roms
, next
) {
714 if (rom
->addr
> addr
) {
717 if (rom
->addr
+ rom
->romsize
< addr
) {
726 * Copies memory from registered ROMs to dest. Any memory that is contained in
727 * a ROM between addr and addr + size is copied. Note that this can involve
728 * multiple ROMs, which need not start at addr and need not end at addr + size.
730 int rom_copy(uint8_t *dest
, target_phys_addr_t addr
, size_t size
)
732 target_phys_addr_t end
= addr
+ size
;
733 uint8_t *s
, *d
= dest
;
737 QTAILQ_FOREACH(rom
, &roms
, next
) {
741 if (rom
->addr
+ rom
->romsize
< addr
) {
744 if (rom
->addr
> end
) {
751 d
= dest
+ (rom
->addr
- addr
);
755 if ((d
+ l
) > (dest
+ size
)) {
762 return (d
+ l
) - dest
;
765 void *rom_ptr(target_phys_addr_t addr
)
769 rom
= find_rom(addr
);
770 if (!rom
|| !rom
->data
)
772 return rom
->data
+ (addr
- rom
->addr
);
775 void do_info_roms(Monitor
*mon
)
779 QTAILQ_FOREACH(rom
, &roms
, next
) {
781 monitor_printf(mon
, "addr=" TARGET_FMT_plx
782 " size=0x%06zx mem=%s name=\"%s\"\n",
783 rom
->addr
, rom
->romsize
,
784 rom
->isrom
? "rom" : "ram",
787 monitor_printf(mon
, "fw=%s/%s"
788 " size=0x%06zx name=\"%s\"\n",