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/>.
45 #include "qemu/osdep.h"
46 #include "qemu-common.h"
47 #include "qapi/error.h"
49 #include "disas/disas.h"
50 #include "migration/vmstate.h"
51 #include "monitor/monitor.h"
52 #include "sysemu/reset.h"
53 #include "sysemu/sysemu.h"
54 #include "uboot_image.h"
55 #include "hw/loader.h"
56 #include "hw/nvram/fw_cfg.h"
57 #include "exec/memory.h"
58 #include "exec/address-spaces.h"
59 #include "hw/boards.h"
60 #include "qemu/cutils.h"
61 #include "sysemu/runstate.h"
65 static int roms_loaded
;
67 /* return the size or -1 if error */
68 int64_t get_image_size(const char *filename
)
72 fd
= open(filename
, O_RDONLY
| O_BINARY
);
75 size
= lseek(fd
, 0, SEEK_END
);
80 /* return the size or -1 if error */
81 ssize_t
load_image_size(const char *filename
, void *addr
, size_t size
)
84 ssize_t actsize
, l
= 0;
86 fd
= open(filename
, O_RDONLY
| O_BINARY
);
91 while ((actsize
= read(fd
, addr
+ l
, size
- l
)) > 0) {
97 return actsize
< 0 ? -1 : l
;
100 /* read()-like version */
101 ssize_t
read_targphys(const char *name
,
102 int fd
, hwaddr dst_addr
, size_t nbytes
)
107 buf
= g_malloc(nbytes
);
108 did
= read(fd
, buf
, nbytes
);
110 rom_add_blob_fixed("read", buf
, did
, dst_addr
);
115 int load_image_targphys(const char *filename
,
116 hwaddr addr
, uint64_t max_sz
)
118 return load_image_targphys_as(filename
, addr
, max_sz
, NULL
);
121 /* return the size or -1 if error */
122 int load_image_targphys_as(const char *filename
,
123 hwaddr addr
, uint64_t max_sz
, AddressSpace
*as
)
127 size
= get_image_size(filename
);
128 if (size
< 0 || size
> max_sz
) {
132 if (rom_add_file_fixed_as(filename
, addr
, -1, as
) < 0) {
139 int load_image_mr(const char *filename
, MemoryRegion
*mr
)
143 if (!memory_access_is_direct(mr
, false)) {
144 /* Can only load an image into RAM or ROM */
148 size
= get_image_size(filename
);
150 if (size
< 0 || size
> memory_region_size(mr
)) {
154 if (rom_add_file_mr(filename
, mr
, -1) < 0) {
161 void pstrcpy_targphys(const char *name
, hwaddr dest
, int buf_size
,
167 if (buf_size
<= 0) return;
168 nulp
= memchr(source
, 0, buf_size
);
170 rom_add_blob_fixed(name
, source
, (nulp
- source
) + 1, dest
);
172 rom_add_blob_fixed(name
, source
, buf_size
, dest
);
173 ptr
= rom_ptr(dest
+ buf_size
- 1, sizeof(*ptr
));
182 uint32_t a_info
; /* Use macros N_MAGIC, etc for access */
183 uint32_t a_text
; /* length of text, in bytes */
184 uint32_t a_data
; /* length of data, in bytes */
185 uint32_t a_bss
; /* length of uninitialized data area, in bytes */
186 uint32_t a_syms
; /* length of symbol table data in file, in bytes */
187 uint32_t a_entry
; /* start address */
188 uint32_t a_trsize
; /* length of relocation info for text, in bytes */
189 uint32_t a_drsize
; /* length of relocation info for data, in bytes */
192 static void bswap_ahdr(struct exec
*e
)
194 bswap32s(&e
->a_info
);
195 bswap32s(&e
->a_text
);
196 bswap32s(&e
->a_data
);
198 bswap32s(&e
->a_syms
);
199 bswap32s(&e
->a_entry
);
200 bswap32s(&e
->a_trsize
);
201 bswap32s(&e
->a_drsize
);
204 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
209 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
210 #define N_TXTOFF(x) \
211 (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) : \
212 (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
213 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
214 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
216 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
218 #define N_DATADDR(x, target_page_size) \
219 (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
220 : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
223 int load_aout(const char *filename
, hwaddr addr
, int max_sz
,
224 int bswap_needed
, hwaddr target_page_size
)
231 fd
= open(filename
, O_RDONLY
| O_BINARY
);
235 size
= read(fd
, &e
, sizeof(e
));
248 if (e
.a_text
+ e
.a_data
> max_sz
)
250 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
251 size
= read_targphys(filename
, fd
, addr
, e
.a_text
+ e
.a_data
);
256 if (N_DATADDR(e
, target_page_size
) + e
.a_data
> max_sz
)
258 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
259 size
= read_targphys(filename
, fd
, addr
, e
.a_text
);
262 ret
= read_targphys(filename
, fd
, addr
+ N_DATADDR(e
, target_page_size
),
280 static void *load_at(int fd
, off_t offset
, size_t size
)
283 if (lseek(fd
, offset
, SEEK_SET
) < 0)
285 ptr
= g_malloc(size
);
286 if (read(fd
, ptr
, size
) != size
) {
297 #define ELF_CLASS ELFCLASS32
301 #define elf_word uint32_t
302 #define elf_sword int32_t
303 #define bswapSZs bswap32s
304 #include "hw/elf_ops.h"
316 #define elfhdr elf64_hdr
317 #define elf_phdr elf64_phdr
318 #define elf_note elf64_note
319 #define elf_shdr elf64_shdr
320 #define elf_sym elf64_sym
321 #define elf_rela elf64_rela
322 #define elf_word uint64_t
323 #define elf_sword int64_t
324 #define bswapSZs bswap64s
326 #include "hw/elf_ops.h"
328 const char *load_elf_strerror(int error
)
333 case ELF_LOAD_FAILED
:
334 return "Failed to load ELF";
335 case ELF_LOAD_NOT_ELF
:
336 return "The image is not ELF";
337 case ELF_LOAD_WRONG_ARCH
:
338 return "The image is from incompatible architecture";
339 case ELF_LOAD_WRONG_ENDIAN
:
340 return "The image has incorrect endianness";
342 return "Unknown error";
346 void load_elf_hdr(const char *filename
, void *hdr
, bool *is64
, Error
**errp
)
349 uint8_t e_ident_local
[EI_NIDENT
];
351 size_t hdr_size
, off
;
359 fd
= open(filename
, O_RDONLY
| O_BINARY
);
361 error_setg_errno(errp
, errno
, "Failed to open file: %s", filename
);
364 if (read(fd
, hdr
, EI_NIDENT
) != EI_NIDENT
) {
365 error_setg_errno(errp
, errno
, "Failed to read file: %s", filename
);
368 if (e_ident
[0] != ELFMAG0
||
369 e_ident
[1] != ELFMAG1
||
370 e_ident
[2] != ELFMAG2
||
371 e_ident
[3] != ELFMAG3
) {
372 error_setg(errp
, "Bad ELF magic");
376 is64l
= e_ident
[EI_CLASS
] == ELFCLASS64
;
377 hdr_size
= is64l
? sizeof(Elf64_Ehdr
) : sizeof(Elf32_Ehdr
);
383 while (hdr
!= e_ident_local
&& off
< hdr_size
) {
384 size_t br
= read(fd
, hdr
+ off
, hdr_size
- off
);
387 error_setg(errp
, "File too short: %s", filename
);
390 error_setg_errno(errp
, errno
, "Failed to read file: %s",
401 /* return < 0 if error, otherwise the number of bytes loaded in memory */
402 int load_elf(const char *filename
,
403 uint64_t (*elf_note_fn
)(void *, void *, bool),
404 uint64_t (*translate_fn
)(void *, uint64_t),
405 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
406 uint64_t *highaddr
, int big_endian
, int elf_machine
,
407 int clear_lsb
, int data_swab
)
409 return load_elf_as(filename
, elf_note_fn
, translate_fn
, translate_opaque
,
410 pentry
, lowaddr
, highaddr
, big_endian
, elf_machine
,
411 clear_lsb
, data_swab
, NULL
);
414 /* return < 0 if error, otherwise the number of bytes loaded in memory */
415 int load_elf_as(const char *filename
,
416 uint64_t (*elf_note_fn
)(void *, void *, bool),
417 uint64_t (*translate_fn
)(void *, uint64_t),
418 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
419 uint64_t *highaddr
, int big_endian
, int elf_machine
,
420 int clear_lsb
, int data_swab
, AddressSpace
*as
)
422 return load_elf_ram(filename
, elf_note_fn
, translate_fn
, translate_opaque
,
423 pentry
, lowaddr
, highaddr
, big_endian
, elf_machine
,
424 clear_lsb
, data_swab
, as
, true);
427 /* return < 0 if error, otherwise the number of bytes loaded in memory */
428 int load_elf_ram(const char *filename
,
429 uint64_t (*elf_note_fn
)(void *, void *, bool),
430 uint64_t (*translate_fn
)(void *, uint64_t),
431 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
432 uint64_t *highaddr
, int big_endian
, int elf_machine
,
433 int clear_lsb
, int data_swab
, AddressSpace
*as
,
436 return load_elf_ram_sym(filename
, elf_note_fn
,
437 translate_fn
, translate_opaque
,
438 pentry
, lowaddr
, highaddr
, big_endian
,
439 elf_machine
, clear_lsb
, data_swab
, as
,
443 /* return < 0 if error, otherwise the number of bytes loaded in memory */
444 int load_elf_ram_sym(const char *filename
,
445 uint64_t (*elf_note_fn
)(void *, void *, bool),
446 uint64_t (*translate_fn
)(void *, uint64_t),
447 void *translate_opaque
, uint64_t *pentry
,
448 uint64_t *lowaddr
, uint64_t *highaddr
, int big_endian
,
449 int elf_machine
, int clear_lsb
, int data_swab
,
450 AddressSpace
*as
, bool load_rom
, symbol_fn_t sym_cb
)
452 int fd
, data_order
, target_data_order
, must_swab
, ret
= ELF_LOAD_FAILED
;
453 uint8_t e_ident
[EI_NIDENT
];
455 fd
= open(filename
, O_RDONLY
| O_BINARY
);
460 if (read(fd
, e_ident
, sizeof(e_ident
)) != sizeof(e_ident
))
462 if (e_ident
[0] != ELFMAG0
||
463 e_ident
[1] != ELFMAG1
||
464 e_ident
[2] != ELFMAG2
||
465 e_ident
[3] != ELFMAG3
) {
466 ret
= ELF_LOAD_NOT_ELF
;
469 #ifdef HOST_WORDS_BIGENDIAN
470 data_order
= ELFDATA2MSB
;
472 data_order
= ELFDATA2LSB
;
474 must_swab
= data_order
!= e_ident
[EI_DATA
];
476 target_data_order
= ELFDATA2MSB
;
478 target_data_order
= ELFDATA2LSB
;
481 if (target_data_order
!= e_ident
[EI_DATA
]) {
482 ret
= ELF_LOAD_WRONG_ENDIAN
;
486 lseek(fd
, 0, SEEK_SET
);
487 if (e_ident
[EI_CLASS
] == ELFCLASS64
) {
488 ret
= load_elf64(filename
, fd
, elf_note_fn
,
489 translate_fn
, translate_opaque
, must_swab
,
490 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
,
491 data_swab
, as
, load_rom
, sym_cb
);
493 ret
= load_elf32(filename
, fd
, elf_note_fn
,
494 translate_fn
, translate_opaque
, must_swab
,
495 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
,
496 data_swab
, as
, load_rom
, sym_cb
);
504 static void bswap_uboot_header(uboot_image_header_t
*hdr
)
506 #ifndef HOST_WORDS_BIGENDIAN
507 bswap32s(&hdr
->ih_magic
);
508 bswap32s(&hdr
->ih_hcrc
);
509 bswap32s(&hdr
->ih_time
);
510 bswap32s(&hdr
->ih_size
);
511 bswap32s(&hdr
->ih_load
);
512 bswap32s(&hdr
->ih_ep
);
513 bswap32s(&hdr
->ih_dcrc
);
518 #define ZALLOC_ALIGNMENT 16
520 static void *zalloc(void *x
, unsigned items
, unsigned size
)
525 size
= (size
+ ZALLOC_ALIGNMENT
- 1) & ~(ZALLOC_ALIGNMENT
- 1);
532 static void zfree(void *x
, void *addr
)
539 #define EXTRA_FIELD 4
542 #define RESERVED 0xe0
546 ssize_t
gunzip(void *dst
, size_t dstlen
, uint8_t *src
, size_t srclen
)
555 if (src
[2] != DEFLATED
|| (flags
& RESERVED
) != 0) {
556 puts ("Error: Bad gzipped data\n");
559 if ((flags
& EXTRA_FIELD
) != 0)
560 i
= 12 + src
[10] + (src
[11] << 8);
561 if ((flags
& ORIG_NAME
) != 0)
562 while (src
[i
++] != 0)
564 if ((flags
& COMMENT
) != 0)
565 while (src
[i
++] != 0)
567 if ((flags
& HEAD_CRC
) != 0)
570 puts ("Error: gunzip out of data in header\n");
577 r
= inflateInit2(&s
, -MAX_WBITS
);
579 printf ("Error: inflateInit2() returned %d\n", r
);
583 s
.avail_in
= srclen
- i
;
585 s
.avail_out
= dstlen
;
586 r
= inflate(&s
, Z_FINISH
);
587 if (r
!= Z_OK
&& r
!= Z_STREAM_END
) {
588 printf ("Error: inflate() returned %d\n", r
);
591 dstbytes
= s
.next_out
- (unsigned char *) dst
;
597 /* Load a U-Boot image. */
598 static int load_uboot_image(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
599 int *is_linux
, uint8_t image_type
,
600 uint64_t (*translate_fn
)(void *, uint64_t),
601 void *translate_opaque
, AddressSpace
*as
)
606 uboot_image_header_t h
;
607 uboot_image_header_t
*hdr
= &h
;
608 uint8_t *data
= NULL
;
610 int do_uncompress
= 0;
612 fd
= open(filename
, O_RDONLY
| O_BINARY
);
616 size
= read(fd
, hdr
, sizeof(uboot_image_header_t
));
617 if (size
< sizeof(uboot_image_header_t
)) {
621 bswap_uboot_header(hdr
);
623 if (hdr
->ih_magic
!= IH_MAGIC
)
626 if (hdr
->ih_type
!= image_type
) {
627 if (!(image_type
== IH_TYPE_KERNEL
&&
628 hdr
->ih_type
== IH_TYPE_KERNEL_NOLOAD
)) {
629 fprintf(stderr
, "Wrong image type %d, expected %d\n", hdr
->ih_type
,
635 /* TODO: Implement other image types. */
636 switch (hdr
->ih_type
) {
637 case IH_TYPE_KERNEL_NOLOAD
:
638 if (!loadaddr
|| *loadaddr
== LOAD_UIMAGE_LOADADDR_INVALID
) {
639 fprintf(stderr
, "this image format (kernel_noload) cannot be "
640 "loaded on this machine type");
644 hdr
->ih_load
= *loadaddr
+ sizeof(*hdr
);
645 hdr
->ih_ep
+= hdr
->ih_load
;
648 address
= hdr
->ih_load
;
650 address
= translate_fn(translate_opaque
, address
);
653 *loadaddr
= hdr
->ih_load
;
656 switch (hdr
->ih_comp
) {
664 "Unable to load u-boot images with compression type %d\n",
673 /* TODO: Check CPU type. */
675 if (hdr
->ih_os
== IH_OS_LINUX
) {
683 case IH_TYPE_RAMDISK
:
687 fprintf(stderr
, "Unsupported u-boot image type %d\n", hdr
->ih_type
);
691 data
= g_malloc(hdr
->ih_size
);
693 if (read(fd
, data
, hdr
->ih_size
) != hdr
->ih_size
) {
694 fprintf(stderr
, "Error reading file\n");
699 uint8_t *compressed_data
;
703 compressed_data
= data
;
704 max_bytes
= UBOOT_MAX_GUNZIP_BYTES
;
705 data
= g_malloc(max_bytes
);
707 bytes
= gunzip(data
, max_bytes
, compressed_data
, hdr
->ih_size
);
708 g_free(compressed_data
);
710 fprintf(stderr
, "Unable to decompress gzipped image!\n");
713 hdr
->ih_size
= bytes
;
716 rom_add_blob_fixed_as(filename
, data
, hdr
->ih_size
, address
, as
);
726 int load_uimage(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
728 uint64_t (*translate_fn
)(void *, uint64_t),
729 void *translate_opaque
)
731 return load_uboot_image(filename
, ep
, loadaddr
, is_linux
, IH_TYPE_KERNEL
,
732 translate_fn
, translate_opaque
, NULL
);
735 int load_uimage_as(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
737 uint64_t (*translate_fn
)(void *, uint64_t),
738 void *translate_opaque
, AddressSpace
*as
)
740 return load_uboot_image(filename
, ep
, loadaddr
, is_linux
, IH_TYPE_KERNEL
,
741 translate_fn
, translate_opaque
, as
);
744 /* Load a ramdisk. */
745 int load_ramdisk(const char *filename
, hwaddr addr
, uint64_t max_sz
)
747 return load_ramdisk_as(filename
, addr
, max_sz
, NULL
);
750 int load_ramdisk_as(const char *filename
, hwaddr addr
, uint64_t max_sz
,
753 return load_uboot_image(filename
, NULL
, &addr
, NULL
, IH_TYPE_RAMDISK
,
757 /* Load a gzip-compressed kernel to a dynamically allocated buffer. */
758 int load_image_gzipped_buffer(const char *filename
, uint64_t max_sz
,
761 uint8_t *compressed_data
= NULL
;
762 uint8_t *data
= NULL
;
767 if (!g_file_get_contents(filename
, (char **) &compressed_data
, &len
,
772 /* Is it a gzip-compressed file? */
774 compressed_data
[0] != 0x1f ||
775 compressed_data
[1] != 0x8b) {
779 if (max_sz
> LOAD_IMAGE_MAX_GUNZIP_BYTES
) {
780 max_sz
= LOAD_IMAGE_MAX_GUNZIP_BYTES
;
783 data
= g_malloc(max_sz
);
784 bytes
= gunzip(data
, max_sz
, compressed_data
, len
);
786 fprintf(stderr
, "%s: unable to decompress gzipped kernel file\n",
791 /* trim to actual size and return to caller */
792 *buffer
= g_realloc(data
, bytes
);
794 /* ownership has been transferred to caller */
798 g_free(compressed_data
);
803 /* Load a gzip-compressed kernel. */
804 int load_image_gzipped(const char *filename
, hwaddr addr
, uint64_t max_sz
)
809 bytes
= load_image_gzipped_buffer(filename
, max_sz
, &data
);
811 rom_add_blob_fixed(filename
, data
, bytes
, addr
);
818 * Functions for reboot-persistent memory regions.
819 * - used for vga bios and option roms.
820 * - also linux kernel (-kernel / -initrd).
823 typedef struct Rom Rom
;
829 /* datasize is the amount of memory allocated in "data". If datasize is less
830 * than romsize, it means that the area from datasize to romsize is filled
842 GMappedFile
*mapped_file
;
847 QTAILQ_ENTRY(Rom
) next
;
850 static FWCfgState
*fw_cfg
;
851 static QTAILQ_HEAD(, Rom
) roms
= QTAILQ_HEAD_INITIALIZER(roms
);
854 * rom->data can be heap-allocated or memory-mapped (e.g. when added with
855 * rom_add_elf_program())
857 static void rom_free_data(Rom
*rom
)
859 if (rom
->mapped_file
) {
860 g_mapped_file_unref(rom
->mapped_file
);
861 rom
->mapped_file
= NULL
;
869 static void rom_free(Rom
*rom
)
875 g_free(rom
->fw_file
);
879 static inline bool rom_order_compare(Rom
*rom
, Rom
*item
)
881 return ((uintptr_t)(void *)rom
->as
> (uintptr_t)(void *)item
->as
) ||
882 (rom
->as
== item
->as
&& rom
->addr
>= item
->addr
);
885 static void rom_insert(Rom
*rom
)
890 hw_error ("ROM images must be loaded at startup\n");
893 /* The user didn't specify an address space, this is the default */
895 rom
->as
= &address_space_memory
;
898 rom
->committed
= false;
900 /* List is ordered by load address in the same address space */
901 QTAILQ_FOREACH(item
, &roms
, next
) {
902 if (rom_order_compare(rom
, item
)) {
905 QTAILQ_INSERT_BEFORE(item
, rom
, next
);
908 QTAILQ_INSERT_TAIL(&roms
, rom
, next
);
911 static void fw_cfg_resized(const char *id
, uint64_t length
, void *host
)
914 fw_cfg_modify_file(fw_cfg
, id
+ strlen("/rom@"), host
, length
);
918 static void *rom_set_mr(Rom
*rom
, Object
*owner
, const char *name
, bool ro
)
922 rom
->mr
= g_malloc(sizeof(*rom
->mr
));
923 memory_region_init_resizeable_ram(rom
->mr
, owner
, name
,
924 rom
->datasize
, rom
->romsize
,
927 memory_region_set_readonly(rom
->mr
, ro
);
928 vmstate_register_ram_global(rom
->mr
);
930 data
= memory_region_get_ram_ptr(rom
->mr
);
931 memcpy(data
, rom
->data
, rom
->datasize
);
936 int rom_add_file(const char *file
, const char *fw_dir
,
937 hwaddr addr
, int32_t bootindex
,
938 bool option_rom
, MemoryRegion
*mr
,
941 MachineClass
*mc
= MACHINE_GET_CLASS(qdev_get_machine());
947 fprintf(stderr
, "Specifying an Address Space and Memory Region is " \
948 "not valid when loading a rom\n");
949 /* We haven't allocated anything so we don't need any cleanup */
953 rom
= g_malloc0(sizeof(*rom
));
954 rom
->name
= g_strdup(file
);
955 rom
->path
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, rom
->name
);
957 if (rom
->path
== NULL
) {
958 rom
->path
= g_strdup(file
);
961 fd
= open(rom
->path
, O_RDONLY
| O_BINARY
);
963 fprintf(stderr
, "Could not open option rom '%s': %s\n",
964 rom
->path
, strerror(errno
));
969 rom
->fw_dir
= g_strdup(fw_dir
);
970 rom
->fw_file
= g_strdup(file
);
973 rom
->romsize
= lseek(fd
, 0, SEEK_END
);
974 if (rom
->romsize
== -1) {
975 fprintf(stderr
, "rom: file %-20s: get size error: %s\n",
976 rom
->name
, strerror(errno
));
980 rom
->datasize
= rom
->romsize
;
981 rom
->data
= g_malloc0(rom
->datasize
);
982 lseek(fd
, 0, SEEK_SET
);
983 rc
= read(fd
, rom
->data
, rom
->datasize
);
984 if (rc
!= rom
->datasize
) {
985 fprintf(stderr
, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
986 rom
->name
, rc
, rom
->datasize
);
991 if (rom
->fw_file
&& fw_cfg
) {
992 const char *basename
;
993 char fw_file_name
[FW_CFG_MAX_FILE_PATH
];
996 basename
= strrchr(rom
->fw_file
, '/');
1000 basename
= rom
->fw_file
;
1002 snprintf(fw_file_name
, sizeof(fw_file_name
), "%s/%s", rom
->fw_dir
,
1004 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
1006 if ((!option_rom
|| mc
->option_rom_has_mr
) && mc
->rom_file_has_mr
) {
1007 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
, true);
1012 fw_cfg_add_file(fw_cfg
, fw_file_name
, data
, rom
->romsize
);
1016 snprintf(devpath
, sizeof(devpath
), "/rom@%s", file
);
1018 snprintf(devpath
, sizeof(devpath
), "/rom@" TARGET_FMT_plx
, addr
);
1022 add_boot_device_path(bootindex
, NULL
, devpath
);
1033 MemoryRegion
*rom_add_blob(const char *name
, const void *blob
, size_t len
,
1034 size_t max_len
, hwaddr addr
, const char *fw_file_name
,
1035 FWCfgCallback fw_callback
, void *callback_opaque
,
1036 AddressSpace
*as
, bool read_only
)
1038 MachineClass
*mc
= MACHINE_GET_CLASS(qdev_get_machine());
1040 MemoryRegion
*mr
= NULL
;
1042 rom
= g_malloc0(sizeof(*rom
));
1043 rom
->name
= g_strdup(name
);
1046 rom
->romsize
= max_len
? max_len
: len
;
1047 rom
->datasize
= len
;
1048 g_assert(rom
->romsize
>= rom
->datasize
);
1049 rom
->data
= g_malloc0(rom
->datasize
);
1050 memcpy(rom
->data
, blob
, len
);
1052 if (fw_file_name
&& fw_cfg
) {
1057 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
1059 snprintf(devpath
, sizeof(devpath
), "/ram@%s", fw_file_name
);
1062 if (mc
->rom_file_has_mr
) {
1063 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
, read_only
);
1069 fw_cfg_add_file_callback(fw_cfg
, fw_file_name
,
1070 fw_callback
, NULL
, callback_opaque
,
1071 data
, rom
->datasize
, read_only
);
1076 /* This function is specific for elf program because we don't need to allocate
1077 * all the rom. We just allocate the first part and the rest is just zeros. This
1078 * is why romsize and datasize are different. Also, this function takes its own
1079 * reference to "mapped_file", so we don't have to allocate and copy the buffer.
1081 int rom_add_elf_program(const char *name
, GMappedFile
*mapped_file
, void *data
,
1082 size_t datasize
, size_t romsize
, hwaddr addr
,
1087 rom
= g_malloc0(sizeof(*rom
));
1088 rom
->name
= g_strdup(name
);
1090 rom
->datasize
= datasize
;
1091 rom
->romsize
= romsize
;
1095 if (mapped_file
&& data
) {
1096 g_mapped_file_ref(mapped_file
);
1097 rom
->mapped_file
= mapped_file
;
1104 int rom_add_vga(const char *file
)
1106 return rom_add_file(file
, "vgaroms", 0, -1, true, NULL
, NULL
);
1109 int rom_add_option(const char *file
, int32_t bootindex
)
1111 return rom_add_file(file
, "genroms", 0, bootindex
, true, NULL
, NULL
);
1114 static void rom_reset(void *unused
)
1119 * We don't need to fill in the RAM with ROM data because we'll fill
1120 * the data in during the next incoming migration in all cases. Note
1121 * that some of those RAMs can actually be modified by the guest on ARM
1122 * so this is probably the only right thing to do here.
1124 if (runstate_check(RUN_STATE_INMIGRATE
))
1127 QTAILQ_FOREACH(rom
, &roms
, next
) {
1131 if (rom
->data
== NULL
) {
1135 void *host
= memory_region_get_ram_ptr(rom
->mr
);
1136 memcpy(host
, rom
->data
, rom
->datasize
);
1138 address_space_write_rom(rom
->as
, rom
->addr
, MEMTXATTRS_UNSPECIFIED
,
1139 rom
->data
, rom
->datasize
);
1142 /* rom needs to be written only once */
1146 * The rom loader is really on the same level as firmware in the guest
1147 * shadowing a ROM into RAM. Such a shadowing mechanism needs to ensure
1148 * that the instruction cache for that new region is clear, so that the
1149 * CPU definitely fetches its instructions from the just written data.
1151 cpu_flush_icache_range(rom
->addr
, rom
->datasize
);
1155 int rom_check_and_register_reset(void)
1158 MemoryRegionSection section
;
1160 AddressSpace
*as
= NULL
;
1162 QTAILQ_FOREACH(rom
, &roms
, next
) {
1167 if ((addr
> rom
->addr
) && (as
== rom
->as
)) {
1168 fprintf(stderr
, "rom: requested regions overlap "
1169 "(rom %s. free=0x" TARGET_FMT_plx
1170 ", addr=0x" TARGET_FMT_plx
")\n",
1171 rom
->name
, addr
, rom
->addr
);
1175 addr
+= rom
->romsize
;
1178 section
= memory_region_find(rom
->mr
? rom
->mr
: get_system_memory(),
1180 rom
->isrom
= int128_nz(section
.size
) && memory_region_is_rom(section
.mr
);
1181 memory_region_unref(section
.mr
);
1183 qemu_register_reset(rom_reset
, NULL
);
1188 void rom_set_fw(FWCfgState
*f
)
1193 void rom_set_order_override(int order
)
1197 fw_cfg_set_order_override(fw_cfg
, order
);
1200 void rom_reset_order_override(void)
1204 fw_cfg_reset_order_override(fw_cfg
);
1207 void rom_transaction_begin(void)
1211 /* Ignore ROMs added without the transaction API */
1212 QTAILQ_FOREACH(rom
, &roms
, next
) {
1213 rom
->committed
= true;
1217 void rom_transaction_end(bool commit
)
1222 QTAILQ_FOREACH_SAFE(rom
, &roms
, next
, tmp
) {
1223 if (rom
->committed
) {
1227 rom
->committed
= true;
1229 QTAILQ_REMOVE(&roms
, rom
, next
);
1235 static Rom
*find_rom(hwaddr addr
, size_t size
)
1239 QTAILQ_FOREACH(rom
, &roms
, next
) {
1246 if (rom
->addr
> addr
) {
1249 if (rom
->addr
+ rom
->romsize
< addr
+ size
) {
1258 * Copies memory from registered ROMs to dest. Any memory that is contained in
1259 * a ROM between addr and addr + size is copied. Note that this can involve
1260 * multiple ROMs, which need not start at addr and need not end at addr + size.
1262 int rom_copy(uint8_t *dest
, hwaddr addr
, size_t size
)
1264 hwaddr end
= addr
+ size
;
1265 uint8_t *s
, *d
= dest
;
1269 QTAILQ_FOREACH(rom
, &roms
, next
) {
1276 if (rom
->addr
+ rom
->romsize
< addr
) {
1279 if (rom
->addr
> end
) {
1283 d
= dest
+ (rom
->addr
- addr
);
1287 if ((d
+ l
) > (dest
+ size
)) {
1295 if (rom
->romsize
> rom
->datasize
) {
1296 /* If datasize is less than romsize, it means that we didn't
1297 * allocate all the ROM because the trailing data are only zeros.
1301 l
= rom
->romsize
- rom
->datasize
;
1303 if ((d
+ l
) > (dest
+ size
)) {
1304 /* Rom size doesn't fit in the destination area. Adjust to avoid
1316 return (d
+ l
) - dest
;
1319 void *rom_ptr(hwaddr addr
, size_t size
)
1323 rom
= find_rom(addr
, size
);
1324 if (!rom
|| !rom
->data
)
1326 return rom
->data
+ (addr
- rom
->addr
);
1329 void hmp_info_roms(Monitor
*mon
, const QDict
*qdict
)
1333 QTAILQ_FOREACH(rom
, &roms
, next
) {
1335 monitor_printf(mon
, "%s"
1336 " size=0x%06zx name=\"%s\"\n",
1337 memory_region_name(rom
->mr
),
1340 } else if (!rom
->fw_file
) {
1341 monitor_printf(mon
, "addr=" TARGET_FMT_plx
1342 " size=0x%06zx mem=%s name=\"%s\"\n",
1343 rom
->addr
, rom
->romsize
,
1344 rom
->isrom
? "rom" : "ram",
1347 monitor_printf(mon
, "fw=%s/%s"
1348 " size=0x%06zx name=\"%s\"\n",
1357 typedef enum HexRecord HexRecord
;
1361 EXT_SEG_ADDR_RECORD
,
1362 START_SEG_ADDR_RECORD
,
1363 EXT_LINEAR_ADDR_RECORD
,
1364 START_LINEAR_ADDR_RECORD
,
1367 /* Each record contains a 16-bit address which is combined with the upper 16
1368 * bits of the implicit "next address" to form a 32-bit address.
1370 #define NEXT_ADDR_MASK 0xffff0000
1372 #define DATA_FIELD_MAX_LEN 0xff
1373 #define LEN_EXCEPT_DATA 0x5
1374 /* 0x5 = sizeof(byte_count) + sizeof(address) + sizeof(record_type) +
1375 * sizeof(checksum) */
1379 uint8_t record_type
;
1380 uint8_t data
[DATA_FIELD_MAX_LEN
];
1384 /* return 0 or -1 if error */
1385 static bool parse_record(HexLine
*line
, uint8_t *our_checksum
, const uint8_t c
,
1386 uint32_t *index
, const bool in_process
)
1388 /* +-------+---------------+-------+---------------------+--------+
1389 * | byte | |record | | |
1390 * | count | address | type | data |checksum|
1391 * +-------+---------------+-------+---------------------+--------+
1393 * |1 byte | 2 bytes |1 byte | 0-255 bytes | 1 byte |
1396 uint32_t idx
= *index
;
1398 if (g_ascii_isspace(c
)) {
1401 if (!g_ascii_isxdigit(c
) || !in_process
) {
1404 value
= g_ascii_xdigit_value(c
);
1405 value
= (idx
& 0x1) ? (value
& 0xf) : (value
<< 4);
1407 line
->byte_count
|= value
;
1408 } else if (2 <= idx
&& idx
< 6) {
1409 line
->address
<<= 4;
1410 line
->address
+= g_ascii_xdigit_value(c
);
1411 } else if (6 <= idx
&& idx
< 8) {
1412 line
->record_type
|= value
;
1413 } else if (8 <= idx
&& idx
< 8 + 2 * line
->byte_count
) {
1414 line
->data
[(idx
- 8) >> 1] |= value
;
1415 } else if (8 + 2 * line
->byte_count
<= idx
&&
1416 idx
< 10 + 2 * line
->byte_count
) {
1417 line
->checksum
|= value
;
1421 *our_checksum
+= value
;
1427 const char *filename
;
1432 uint32_t next_address_to_write
;
1433 uint32_t current_address
;
1434 uint32_t current_rom_index
;
1435 uint32_t rom_start_address
;
1439 /* return size or -1 if error */
1440 static int handle_record_type(HexParser
*parser
)
1442 HexLine
*line
= &(parser
->line
);
1443 switch (line
->record_type
) {
1445 parser
->current_address
=
1446 (parser
->next_address_to_write
& NEXT_ADDR_MASK
) | line
->address
;
1447 /* verify this is a contiguous block of memory */
1448 if (parser
->current_address
!= parser
->next_address_to_write
) {
1449 if (parser
->current_rom_index
!= 0) {
1450 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1451 parser
->current_rom_index
,
1452 parser
->rom_start_address
, parser
->as
);
1454 parser
->rom_start_address
= parser
->current_address
;
1455 parser
->current_rom_index
= 0;
1458 /* copy from line buffer to output bin_buf */
1459 memcpy(parser
->bin_buf
+ parser
->current_rom_index
, line
->data
,
1461 parser
->current_rom_index
+= line
->byte_count
;
1462 parser
->total_size
+= line
->byte_count
;
1463 /* save next address to write */
1464 parser
->next_address_to_write
=
1465 parser
->current_address
+ line
->byte_count
;
1469 if (parser
->current_rom_index
!= 0) {
1470 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1471 parser
->current_rom_index
,
1472 parser
->rom_start_address
, parser
->as
);
1474 return parser
->total_size
;
1475 case EXT_SEG_ADDR_RECORD
:
1476 case EXT_LINEAR_ADDR_RECORD
:
1477 if (line
->byte_count
!= 2 && line
->address
!= 0) {
1481 if (parser
->current_rom_index
!= 0) {
1482 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1483 parser
->current_rom_index
,
1484 parser
->rom_start_address
, parser
->as
);
1487 /* save next address to write,
1488 * in case of non-contiguous block of memory */
1489 parser
->next_address_to_write
= (line
->data
[0] << 12) |
1490 (line
->data
[1] << 4);
1491 if (line
->record_type
== EXT_LINEAR_ADDR_RECORD
) {
1492 parser
->next_address_to_write
<<= 12;
1495 parser
->rom_start_address
= parser
->next_address_to_write
;
1496 parser
->current_rom_index
= 0;
1499 case START_SEG_ADDR_RECORD
:
1500 if (line
->byte_count
!= 4 && line
->address
!= 0) {
1504 /* x86 16-bit CS:IP segmented addressing */
1505 *(parser
->start_addr
) = (((line
->data
[0] << 8) | line
->data
[1]) << 4) +
1506 ((line
->data
[2] << 8) | line
->data
[3]);
1509 case START_LINEAR_ADDR_RECORD
:
1510 if (line
->byte_count
!= 4 && line
->address
!= 0) {
1514 *(parser
->start_addr
) = ldl_be_p(line
->data
);
1521 return parser
->total_size
;
1524 /* return size or -1 if error */
1525 static int parse_hex_blob(const char *filename
, hwaddr
*addr
, uint8_t *hex_blob
,
1526 size_t hex_blob_size
, AddressSpace
*as
)
1528 bool in_process
= false; /* avoid re-enter and
1529 * check whether record begin with ':' */
1530 uint8_t *end
= hex_blob
+ hex_blob_size
;
1531 uint8_t our_checksum
= 0;
1532 uint32_t record_index
= 0;
1533 HexParser parser
= {
1534 .filename
= filename
,
1535 .bin_buf
= g_malloc(hex_blob_size
),
1540 rom_transaction_begin();
1542 for (; hex_blob
< end
; ++hex_blob
) {
1543 switch (*hex_blob
) {
1551 if ((LEN_EXCEPT_DATA
+ parser
.line
.byte_count
) * 2 !=
1553 our_checksum
!= 0) {
1554 parser
.total_size
= -1;
1558 if (handle_record_type(&parser
) == -1) {
1559 parser
.total_size
= -1;
1564 /* start of a new record. */
1566 memset(&parser
.line
, 0, sizeof(HexLine
));
1571 /* decoding lines */
1573 if (!parse_record(&parser
.line
, &our_checksum
, *hex_blob
,
1574 &record_index
, in_process
)) {
1575 parser
.total_size
= -1;
1583 g_free(parser
.bin_buf
);
1584 rom_transaction_end(parser
.total_size
!= -1);
1585 return parser
.total_size
;
1588 /* return size or -1 if error */
1589 int load_targphys_hex_as(const char *filename
, hwaddr
*entry
, AddressSpace
*as
)
1591 gsize hex_blob_size
;
1595 if (!g_file_get_contents(filename
, &hex_blob
, &hex_blob_size
, NULL
)) {
1599 total_size
= parse_hex_blob(filename
, entry
, (uint8_t *)hex_blob
,