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 "monitor/monitor.h"
51 #include "sysemu/reset.h"
52 #include "sysemu/sysemu.h"
53 #include "uboot_image.h"
54 #include "hw/loader.h"
55 #include "hw/nvram/fw_cfg.h"
56 #include "exec/memory.h"
57 #include "exec/address-spaces.h"
58 #include "hw/boards.h"
59 #include "qemu/cutils.h"
63 static int roms_loaded
;
65 /* return the size or -1 if error */
66 int64_t get_image_size(const char *filename
)
70 fd
= open(filename
, O_RDONLY
| O_BINARY
);
73 size
= lseek(fd
, 0, SEEK_END
);
78 /* return the size or -1 if error */
79 ssize_t
load_image_size(const char *filename
, void *addr
, size_t size
)
82 ssize_t actsize
, l
= 0;
84 fd
= open(filename
, O_RDONLY
| O_BINARY
);
89 while ((actsize
= read(fd
, addr
+ l
, size
- l
)) > 0) {
95 return actsize
< 0 ? -1 : l
;
98 /* read()-like version */
99 ssize_t
read_targphys(const char *name
,
100 int fd
, hwaddr dst_addr
, size_t nbytes
)
105 buf
= g_malloc(nbytes
);
106 did
= read(fd
, buf
, nbytes
);
108 rom_add_blob_fixed("read", buf
, did
, dst_addr
);
113 int load_image_targphys(const char *filename
,
114 hwaddr addr
, uint64_t max_sz
)
116 return load_image_targphys_as(filename
, addr
, max_sz
, NULL
);
119 /* return the size or -1 if error */
120 int load_image_targphys_as(const char *filename
,
121 hwaddr addr
, uint64_t max_sz
, AddressSpace
*as
)
125 size
= get_image_size(filename
);
126 if (size
< 0 || size
> max_sz
) {
130 if (rom_add_file_fixed_as(filename
, addr
, -1, as
) < 0) {
137 int load_image_mr(const char *filename
, MemoryRegion
*mr
)
141 if (!memory_access_is_direct(mr
, false)) {
142 /* Can only load an image into RAM or ROM */
146 size
= get_image_size(filename
);
148 if (size
< 0 || size
> memory_region_size(mr
)) {
152 if (rom_add_file_mr(filename
, mr
, -1) < 0) {
159 void pstrcpy_targphys(const char *name
, hwaddr dest
, int buf_size
,
165 if (buf_size
<= 0) return;
166 nulp
= memchr(source
, 0, buf_size
);
168 rom_add_blob_fixed(name
, source
, (nulp
- source
) + 1, dest
);
170 rom_add_blob_fixed(name
, source
, buf_size
, dest
);
171 ptr
= rom_ptr(dest
+ buf_size
- 1, sizeof(*ptr
));
180 uint32_t a_info
; /* Use macros N_MAGIC, etc for access */
181 uint32_t a_text
; /* length of text, in bytes */
182 uint32_t a_data
; /* length of data, in bytes */
183 uint32_t a_bss
; /* length of uninitialized data area, in bytes */
184 uint32_t a_syms
; /* length of symbol table data in file, in bytes */
185 uint32_t a_entry
; /* start address */
186 uint32_t a_trsize
; /* length of relocation info for text, in bytes */
187 uint32_t a_drsize
; /* length of relocation info for data, in bytes */
190 static void bswap_ahdr(struct exec
*e
)
192 bswap32s(&e
->a_info
);
193 bswap32s(&e
->a_text
);
194 bswap32s(&e
->a_data
);
196 bswap32s(&e
->a_syms
);
197 bswap32s(&e
->a_entry
);
198 bswap32s(&e
->a_trsize
);
199 bswap32s(&e
->a_drsize
);
202 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
207 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
208 #define N_TXTOFF(x) \
209 (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) : \
210 (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
211 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
212 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
214 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
216 #define N_DATADDR(x, target_page_size) \
217 (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
218 : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
221 int load_aout(const char *filename
, hwaddr addr
, int max_sz
,
222 int bswap_needed
, hwaddr target_page_size
)
229 fd
= open(filename
, O_RDONLY
| O_BINARY
);
233 size
= read(fd
, &e
, sizeof(e
));
246 if (e
.a_text
+ e
.a_data
> max_sz
)
248 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
249 size
= read_targphys(filename
, fd
, addr
, e
.a_text
+ e
.a_data
);
254 if (N_DATADDR(e
, target_page_size
) + e
.a_data
> max_sz
)
256 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
257 size
= read_targphys(filename
, fd
, addr
, e
.a_text
);
260 ret
= read_targphys(filename
, fd
, addr
+ N_DATADDR(e
, target_page_size
),
278 static void *load_at(int fd
, off_t offset
, size_t size
)
281 if (lseek(fd
, offset
, SEEK_SET
) < 0)
283 ptr
= g_malloc(size
);
284 if (read(fd
, ptr
, size
) != size
) {
295 #define ELF_CLASS ELFCLASS32
299 #define elf_word uint32_t
300 #define elf_sword int32_t
301 #define bswapSZs bswap32s
302 #include "hw/elf_ops.h"
314 #define elfhdr elf64_hdr
315 #define elf_phdr elf64_phdr
316 #define elf_note elf64_note
317 #define elf_shdr elf64_shdr
318 #define elf_sym elf64_sym
319 #define elf_rela elf64_rela
320 #define elf_word uint64_t
321 #define elf_sword int64_t
322 #define bswapSZs bswap64s
324 #include "hw/elf_ops.h"
326 const char *load_elf_strerror(int error
)
331 case ELF_LOAD_FAILED
:
332 return "Failed to load ELF";
333 case ELF_LOAD_NOT_ELF
:
334 return "The image is not ELF";
335 case ELF_LOAD_WRONG_ARCH
:
336 return "The image is from incompatible architecture";
337 case ELF_LOAD_WRONG_ENDIAN
:
338 return "The image has incorrect endianness";
340 return "Unknown error";
344 void load_elf_hdr(const char *filename
, void *hdr
, bool *is64
, Error
**errp
)
347 uint8_t e_ident_local
[EI_NIDENT
];
349 size_t hdr_size
, off
;
357 fd
= open(filename
, O_RDONLY
| O_BINARY
);
359 error_setg_errno(errp
, errno
, "Failed to open file: %s", filename
);
362 if (read(fd
, hdr
, EI_NIDENT
) != EI_NIDENT
) {
363 error_setg_errno(errp
, errno
, "Failed to read file: %s", filename
);
366 if (e_ident
[0] != ELFMAG0
||
367 e_ident
[1] != ELFMAG1
||
368 e_ident
[2] != ELFMAG2
||
369 e_ident
[3] != ELFMAG3
) {
370 error_setg(errp
, "Bad ELF magic");
374 is64l
= e_ident
[EI_CLASS
] == ELFCLASS64
;
375 hdr_size
= is64l
? sizeof(Elf64_Ehdr
) : sizeof(Elf32_Ehdr
);
381 while (hdr
!= e_ident_local
&& off
< hdr_size
) {
382 size_t br
= read(fd
, hdr
+ off
, hdr_size
- off
);
385 error_setg(errp
, "File too short: %s", filename
);
388 error_setg_errno(errp
, errno
, "Failed to read file: %s",
399 /* return < 0 if error, otherwise the number of bytes loaded in memory */
400 int load_elf(const char *filename
,
401 uint64_t (*elf_note_fn
)(void *, void *, bool),
402 uint64_t (*translate_fn
)(void *, uint64_t),
403 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
404 uint64_t *highaddr
, int big_endian
, int elf_machine
,
405 int clear_lsb
, int data_swab
)
407 return load_elf_as(filename
, elf_note_fn
, translate_fn
, translate_opaque
,
408 pentry
, lowaddr
, highaddr
, big_endian
, elf_machine
,
409 clear_lsb
, data_swab
, NULL
);
412 /* return < 0 if error, otherwise the number of bytes loaded in memory */
413 int load_elf_as(const char *filename
,
414 uint64_t (*elf_note_fn
)(void *, void *, bool),
415 uint64_t (*translate_fn
)(void *, uint64_t),
416 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
417 uint64_t *highaddr
, int big_endian
, int elf_machine
,
418 int clear_lsb
, int data_swab
, AddressSpace
*as
)
420 return load_elf_ram(filename
, elf_note_fn
, translate_fn
, translate_opaque
,
421 pentry
, lowaddr
, highaddr
, big_endian
, elf_machine
,
422 clear_lsb
, data_swab
, as
, true);
425 /* return < 0 if error, otherwise the number of bytes loaded in memory */
426 int load_elf_ram(const char *filename
,
427 uint64_t (*elf_note_fn
)(void *, void *, bool),
428 uint64_t (*translate_fn
)(void *, uint64_t),
429 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
430 uint64_t *highaddr
, int big_endian
, int elf_machine
,
431 int clear_lsb
, int data_swab
, AddressSpace
*as
,
434 return load_elf_ram_sym(filename
, elf_note_fn
,
435 translate_fn
, translate_opaque
,
436 pentry
, lowaddr
, highaddr
, big_endian
,
437 elf_machine
, clear_lsb
, data_swab
, as
,
441 /* return < 0 if error, otherwise the number of bytes loaded in memory */
442 int load_elf_ram_sym(const char *filename
,
443 uint64_t (*elf_note_fn
)(void *, void *, bool),
444 uint64_t (*translate_fn
)(void *, uint64_t),
445 void *translate_opaque
, uint64_t *pentry
,
446 uint64_t *lowaddr
, uint64_t *highaddr
, int big_endian
,
447 int elf_machine
, int clear_lsb
, int data_swab
,
448 AddressSpace
*as
, bool load_rom
, symbol_fn_t sym_cb
)
450 int fd
, data_order
, target_data_order
, must_swab
, ret
= ELF_LOAD_FAILED
;
451 uint8_t e_ident
[EI_NIDENT
];
453 fd
= open(filename
, O_RDONLY
| O_BINARY
);
458 if (read(fd
, e_ident
, sizeof(e_ident
)) != sizeof(e_ident
))
460 if (e_ident
[0] != ELFMAG0
||
461 e_ident
[1] != ELFMAG1
||
462 e_ident
[2] != ELFMAG2
||
463 e_ident
[3] != ELFMAG3
) {
464 ret
= ELF_LOAD_NOT_ELF
;
467 #ifdef HOST_WORDS_BIGENDIAN
468 data_order
= ELFDATA2MSB
;
470 data_order
= ELFDATA2LSB
;
472 must_swab
= data_order
!= e_ident
[EI_DATA
];
474 target_data_order
= ELFDATA2MSB
;
476 target_data_order
= ELFDATA2LSB
;
479 if (target_data_order
!= e_ident
[EI_DATA
]) {
480 ret
= ELF_LOAD_WRONG_ENDIAN
;
484 lseek(fd
, 0, SEEK_SET
);
485 if (e_ident
[EI_CLASS
] == ELFCLASS64
) {
486 ret
= load_elf64(filename
, fd
, elf_note_fn
,
487 translate_fn
, translate_opaque
, must_swab
,
488 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
,
489 data_swab
, as
, load_rom
, sym_cb
);
491 ret
= load_elf32(filename
, fd
, elf_note_fn
,
492 translate_fn
, translate_opaque
, must_swab
,
493 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
,
494 data_swab
, as
, load_rom
, sym_cb
);
502 static void bswap_uboot_header(uboot_image_header_t
*hdr
)
504 #ifndef HOST_WORDS_BIGENDIAN
505 bswap32s(&hdr
->ih_magic
);
506 bswap32s(&hdr
->ih_hcrc
);
507 bswap32s(&hdr
->ih_time
);
508 bswap32s(&hdr
->ih_size
);
509 bswap32s(&hdr
->ih_load
);
510 bswap32s(&hdr
->ih_ep
);
511 bswap32s(&hdr
->ih_dcrc
);
516 #define ZALLOC_ALIGNMENT 16
518 static void *zalloc(void *x
, unsigned items
, unsigned size
)
523 size
= (size
+ ZALLOC_ALIGNMENT
- 1) & ~(ZALLOC_ALIGNMENT
- 1);
530 static void zfree(void *x
, void *addr
)
537 #define EXTRA_FIELD 4
540 #define RESERVED 0xe0
544 ssize_t
gunzip(void *dst
, size_t dstlen
, uint8_t *src
, size_t srclen
)
553 if (src
[2] != DEFLATED
|| (flags
& RESERVED
) != 0) {
554 puts ("Error: Bad gzipped data\n");
557 if ((flags
& EXTRA_FIELD
) != 0)
558 i
= 12 + src
[10] + (src
[11] << 8);
559 if ((flags
& ORIG_NAME
) != 0)
560 while (src
[i
++] != 0)
562 if ((flags
& COMMENT
) != 0)
563 while (src
[i
++] != 0)
565 if ((flags
& HEAD_CRC
) != 0)
568 puts ("Error: gunzip out of data in header\n");
575 r
= inflateInit2(&s
, -MAX_WBITS
);
577 printf ("Error: inflateInit2() returned %d\n", r
);
581 s
.avail_in
= srclen
- i
;
583 s
.avail_out
= dstlen
;
584 r
= inflate(&s
, Z_FINISH
);
585 if (r
!= Z_OK
&& r
!= Z_STREAM_END
) {
586 printf ("Error: inflate() returned %d\n", r
);
589 dstbytes
= s
.next_out
- (unsigned char *) dst
;
595 /* Load a U-Boot image. */
596 static int load_uboot_image(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
597 int *is_linux
, uint8_t image_type
,
598 uint64_t (*translate_fn
)(void *, uint64_t),
599 void *translate_opaque
, AddressSpace
*as
)
604 uboot_image_header_t h
;
605 uboot_image_header_t
*hdr
= &h
;
606 uint8_t *data
= NULL
;
608 int do_uncompress
= 0;
610 fd
= open(filename
, O_RDONLY
| O_BINARY
);
614 size
= read(fd
, hdr
, sizeof(uboot_image_header_t
));
615 if (size
< sizeof(uboot_image_header_t
)) {
619 bswap_uboot_header(hdr
);
621 if (hdr
->ih_magic
!= IH_MAGIC
)
624 if (hdr
->ih_type
!= image_type
) {
625 if (!(image_type
== IH_TYPE_KERNEL
&&
626 hdr
->ih_type
== IH_TYPE_KERNEL_NOLOAD
)) {
627 fprintf(stderr
, "Wrong image type %d, expected %d\n", hdr
->ih_type
,
633 /* TODO: Implement other image types. */
634 switch (hdr
->ih_type
) {
635 case IH_TYPE_KERNEL_NOLOAD
:
636 if (!loadaddr
|| *loadaddr
== LOAD_UIMAGE_LOADADDR_INVALID
) {
637 fprintf(stderr
, "this image format (kernel_noload) cannot be "
638 "loaded on this machine type");
642 hdr
->ih_load
= *loadaddr
+ sizeof(*hdr
);
643 hdr
->ih_ep
+= hdr
->ih_load
;
646 address
= hdr
->ih_load
;
648 address
= translate_fn(translate_opaque
, address
);
651 *loadaddr
= hdr
->ih_load
;
654 switch (hdr
->ih_comp
) {
662 "Unable to load u-boot images with compression type %d\n",
671 /* TODO: Check CPU type. */
673 if (hdr
->ih_os
== IH_OS_LINUX
) {
681 case IH_TYPE_RAMDISK
:
685 fprintf(stderr
, "Unsupported u-boot image type %d\n", hdr
->ih_type
);
689 data
= g_malloc(hdr
->ih_size
);
691 if (read(fd
, data
, hdr
->ih_size
) != hdr
->ih_size
) {
692 fprintf(stderr
, "Error reading file\n");
697 uint8_t *compressed_data
;
701 compressed_data
= data
;
702 max_bytes
= UBOOT_MAX_GUNZIP_BYTES
;
703 data
= g_malloc(max_bytes
);
705 bytes
= gunzip(data
, max_bytes
, compressed_data
, hdr
->ih_size
);
706 g_free(compressed_data
);
708 fprintf(stderr
, "Unable to decompress gzipped image!\n");
711 hdr
->ih_size
= bytes
;
714 rom_add_blob_fixed_as(filename
, data
, hdr
->ih_size
, address
, as
);
724 int load_uimage(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
726 uint64_t (*translate_fn
)(void *, uint64_t),
727 void *translate_opaque
)
729 return load_uboot_image(filename
, ep
, loadaddr
, is_linux
, IH_TYPE_KERNEL
,
730 translate_fn
, translate_opaque
, NULL
);
733 int load_uimage_as(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
735 uint64_t (*translate_fn
)(void *, uint64_t),
736 void *translate_opaque
, AddressSpace
*as
)
738 return load_uboot_image(filename
, ep
, loadaddr
, is_linux
, IH_TYPE_KERNEL
,
739 translate_fn
, translate_opaque
, as
);
742 /* Load a ramdisk. */
743 int load_ramdisk(const char *filename
, hwaddr addr
, uint64_t max_sz
)
745 return load_ramdisk_as(filename
, addr
, max_sz
, NULL
);
748 int load_ramdisk_as(const char *filename
, hwaddr addr
, uint64_t max_sz
,
751 return load_uboot_image(filename
, NULL
, &addr
, NULL
, IH_TYPE_RAMDISK
,
755 /* Load a gzip-compressed kernel to a dynamically allocated buffer. */
756 int load_image_gzipped_buffer(const char *filename
, uint64_t max_sz
,
759 uint8_t *compressed_data
= NULL
;
760 uint8_t *data
= NULL
;
765 if (!g_file_get_contents(filename
, (char **) &compressed_data
, &len
,
770 /* Is it a gzip-compressed file? */
772 compressed_data
[0] != 0x1f ||
773 compressed_data
[1] != 0x8b) {
777 if (max_sz
> LOAD_IMAGE_MAX_GUNZIP_BYTES
) {
778 max_sz
= LOAD_IMAGE_MAX_GUNZIP_BYTES
;
781 data
= g_malloc(max_sz
);
782 bytes
= gunzip(data
, max_sz
, compressed_data
, len
);
784 fprintf(stderr
, "%s: unable to decompress gzipped kernel file\n",
789 /* trim to actual size and return to caller */
790 *buffer
= g_realloc(data
, bytes
);
792 /* ownership has been transferred to caller */
796 g_free(compressed_data
);
801 /* Load a gzip-compressed kernel. */
802 int load_image_gzipped(const char *filename
, hwaddr addr
, uint64_t max_sz
)
807 bytes
= load_image_gzipped_buffer(filename
, max_sz
, &data
);
809 rom_add_blob_fixed(filename
, data
, bytes
, addr
);
816 * Functions for reboot-persistent memory regions.
817 * - used for vga bios and option roms.
818 * - also linux kernel (-kernel / -initrd).
821 typedef struct Rom Rom
;
827 /* datasize is the amount of memory allocated in "data". If datasize is less
828 * than romsize, it means that the area from datasize to romsize is filled
844 QTAILQ_ENTRY(Rom
) next
;
847 static FWCfgState
*fw_cfg
;
848 static QTAILQ_HEAD(, Rom
) roms
= QTAILQ_HEAD_INITIALIZER(roms
);
850 /* rom->data must be heap-allocated (do not use with rom_add_elf_program()) */
851 static void rom_free(Rom
*rom
)
857 g_free(rom
->fw_file
);
861 static inline bool rom_order_compare(Rom
*rom
, Rom
*item
)
863 return ((uintptr_t)(void *)rom
->as
> (uintptr_t)(void *)item
->as
) ||
864 (rom
->as
== item
->as
&& rom
->addr
>= item
->addr
);
867 static void rom_insert(Rom
*rom
)
872 hw_error ("ROM images must be loaded at startup\n");
875 /* The user didn't specify an address space, this is the default */
877 rom
->as
= &address_space_memory
;
880 rom
->committed
= false;
882 /* List is ordered by load address in the same address space */
883 QTAILQ_FOREACH(item
, &roms
, next
) {
884 if (rom_order_compare(rom
, item
)) {
887 QTAILQ_INSERT_BEFORE(item
, rom
, next
);
890 QTAILQ_INSERT_TAIL(&roms
, rom
, next
);
893 static void fw_cfg_resized(const char *id
, uint64_t length
, void *host
)
896 fw_cfg_modify_file(fw_cfg
, id
+ strlen("/rom@"), host
, length
);
900 static void *rom_set_mr(Rom
*rom
, Object
*owner
, const char *name
, bool ro
)
904 rom
->mr
= g_malloc(sizeof(*rom
->mr
));
905 memory_region_init_resizeable_ram(rom
->mr
, owner
, name
,
906 rom
->datasize
, rom
->romsize
,
909 memory_region_set_readonly(rom
->mr
, ro
);
910 vmstate_register_ram_global(rom
->mr
);
912 data
= memory_region_get_ram_ptr(rom
->mr
);
913 memcpy(data
, rom
->data
, rom
->datasize
);
918 int rom_add_file(const char *file
, const char *fw_dir
,
919 hwaddr addr
, int32_t bootindex
,
920 bool option_rom
, MemoryRegion
*mr
,
923 MachineClass
*mc
= MACHINE_GET_CLASS(qdev_get_machine());
929 fprintf(stderr
, "Specifying an Address Space and Memory Region is " \
930 "not valid when loading a rom\n");
931 /* We haven't allocated anything so we don't need any cleanup */
935 rom
= g_malloc0(sizeof(*rom
));
936 rom
->name
= g_strdup(file
);
937 rom
->path
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, rom
->name
);
939 if (rom
->path
== NULL
) {
940 rom
->path
= g_strdup(file
);
943 fd
= open(rom
->path
, O_RDONLY
| O_BINARY
);
945 fprintf(stderr
, "Could not open option rom '%s': %s\n",
946 rom
->path
, strerror(errno
));
951 rom
->fw_dir
= g_strdup(fw_dir
);
952 rom
->fw_file
= g_strdup(file
);
955 rom
->romsize
= lseek(fd
, 0, SEEK_END
);
956 if (rom
->romsize
== -1) {
957 fprintf(stderr
, "rom: file %-20s: get size error: %s\n",
958 rom
->name
, strerror(errno
));
962 rom
->datasize
= rom
->romsize
;
963 rom
->data
= g_malloc0(rom
->datasize
);
964 lseek(fd
, 0, SEEK_SET
);
965 rc
= read(fd
, rom
->data
, rom
->datasize
);
966 if (rc
!= rom
->datasize
) {
967 fprintf(stderr
, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
968 rom
->name
, rc
, rom
->datasize
);
973 if (rom
->fw_file
&& fw_cfg
) {
974 const char *basename
;
975 char fw_file_name
[FW_CFG_MAX_FILE_PATH
];
978 basename
= strrchr(rom
->fw_file
, '/');
982 basename
= rom
->fw_file
;
984 snprintf(fw_file_name
, sizeof(fw_file_name
), "%s/%s", rom
->fw_dir
,
986 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
988 if ((!option_rom
|| mc
->option_rom_has_mr
) && mc
->rom_file_has_mr
) {
989 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
, true);
994 fw_cfg_add_file(fw_cfg
, fw_file_name
, data
, rom
->romsize
);
998 snprintf(devpath
, sizeof(devpath
), "/rom@%s", file
);
1000 snprintf(devpath
, sizeof(devpath
), "/rom@" TARGET_FMT_plx
, addr
);
1004 add_boot_device_path(bootindex
, NULL
, devpath
);
1015 MemoryRegion
*rom_add_blob(const char *name
, const void *blob
, size_t len
,
1016 size_t max_len
, hwaddr addr
, const char *fw_file_name
,
1017 FWCfgCallback fw_callback
, void *callback_opaque
,
1018 AddressSpace
*as
, bool read_only
)
1020 MachineClass
*mc
= MACHINE_GET_CLASS(qdev_get_machine());
1022 MemoryRegion
*mr
= NULL
;
1024 rom
= g_malloc0(sizeof(*rom
));
1025 rom
->name
= g_strdup(name
);
1028 rom
->romsize
= max_len
? max_len
: len
;
1029 rom
->datasize
= len
;
1030 g_assert(rom
->romsize
>= rom
->datasize
);
1031 rom
->data
= g_malloc0(rom
->datasize
);
1032 memcpy(rom
->data
, blob
, len
);
1034 if (fw_file_name
&& fw_cfg
) {
1039 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
1041 snprintf(devpath
, sizeof(devpath
), "/ram@%s", fw_file_name
);
1044 if (mc
->rom_file_has_mr
) {
1045 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
, read_only
);
1051 fw_cfg_add_file_callback(fw_cfg
, fw_file_name
,
1052 fw_callback
, NULL
, callback_opaque
,
1053 data
, rom
->datasize
, read_only
);
1058 /* This function is specific for elf program because we don't need to allocate
1059 * all the rom. We just allocate the first part and the rest is just zeros. This
1060 * is why romsize and datasize are different. Also, this function seize the
1061 * memory ownership of "data", so we don't have to allocate and copy the buffer.
1063 int rom_add_elf_program(const char *name
, void *data
, size_t datasize
,
1064 size_t romsize
, hwaddr addr
, AddressSpace
*as
)
1068 rom
= g_malloc0(sizeof(*rom
));
1069 rom
->name
= g_strdup(name
);
1071 rom
->datasize
= datasize
;
1072 rom
->romsize
= romsize
;
1079 int rom_add_vga(const char *file
)
1081 return rom_add_file(file
, "vgaroms", 0, -1, true, NULL
, NULL
);
1084 int rom_add_option(const char *file
, int32_t bootindex
)
1086 return rom_add_file(file
, "genroms", 0, bootindex
, true, NULL
, NULL
);
1089 static void rom_reset(void *unused
)
1093 QTAILQ_FOREACH(rom
, &roms
, next
) {
1097 if (rom
->data
== NULL
) {
1101 void *host
= memory_region_get_ram_ptr(rom
->mr
);
1102 memcpy(host
, rom
->data
, rom
->datasize
);
1104 address_space_write_rom(rom
->as
, rom
->addr
, MEMTXATTRS_UNSPECIFIED
,
1105 rom
->data
, rom
->datasize
);
1108 /* rom needs to be written only once */
1113 * The rom loader is really on the same level as firmware in the guest
1114 * shadowing a ROM into RAM. Such a shadowing mechanism needs to ensure
1115 * that the instruction cache for that new region is clear, so that the
1116 * CPU definitely fetches its instructions from the just written data.
1118 cpu_flush_icache_range(rom
->addr
, rom
->datasize
);
1122 int rom_check_and_register_reset(void)
1125 MemoryRegionSection section
;
1127 AddressSpace
*as
= NULL
;
1129 QTAILQ_FOREACH(rom
, &roms
, next
) {
1134 if ((addr
> rom
->addr
) && (as
== rom
->as
)) {
1135 fprintf(stderr
, "rom: requested regions overlap "
1136 "(rom %s. free=0x" TARGET_FMT_plx
1137 ", addr=0x" TARGET_FMT_plx
")\n",
1138 rom
->name
, addr
, rom
->addr
);
1142 addr
+= rom
->romsize
;
1145 section
= memory_region_find(rom
->mr
? rom
->mr
: get_system_memory(),
1147 rom
->isrom
= int128_nz(section
.size
) && memory_region_is_rom(section
.mr
);
1148 memory_region_unref(section
.mr
);
1150 qemu_register_reset(rom_reset
, NULL
);
1155 void rom_set_fw(FWCfgState
*f
)
1160 void rom_set_order_override(int order
)
1164 fw_cfg_set_order_override(fw_cfg
, order
);
1167 void rom_reset_order_override(void)
1171 fw_cfg_reset_order_override(fw_cfg
);
1174 void rom_transaction_begin(void)
1178 /* Ignore ROMs added without the transaction API */
1179 QTAILQ_FOREACH(rom
, &roms
, next
) {
1180 rom
->committed
= true;
1184 void rom_transaction_end(bool commit
)
1189 QTAILQ_FOREACH_SAFE(rom
, &roms
, next
, tmp
) {
1190 if (rom
->committed
) {
1194 rom
->committed
= true;
1196 QTAILQ_REMOVE(&roms
, rom
, next
);
1202 static Rom
*find_rom(hwaddr addr
, size_t size
)
1206 QTAILQ_FOREACH(rom
, &roms
, next
) {
1213 if (rom
->addr
> addr
) {
1216 if (rom
->addr
+ rom
->romsize
< addr
+ size
) {
1225 * Copies memory from registered ROMs to dest. Any memory that is contained in
1226 * a ROM between addr and addr + size is copied. Note that this can involve
1227 * multiple ROMs, which need not start at addr and need not end at addr + size.
1229 int rom_copy(uint8_t *dest
, hwaddr addr
, size_t size
)
1231 hwaddr end
= addr
+ size
;
1232 uint8_t *s
, *d
= dest
;
1236 QTAILQ_FOREACH(rom
, &roms
, next
) {
1243 if (rom
->addr
+ rom
->romsize
< addr
) {
1246 if (rom
->addr
> end
) {
1250 d
= dest
+ (rom
->addr
- addr
);
1254 if ((d
+ l
) > (dest
+ size
)) {
1262 if (rom
->romsize
> rom
->datasize
) {
1263 /* If datasize is less than romsize, it means that we didn't
1264 * allocate all the ROM because the trailing data are only zeros.
1268 l
= rom
->romsize
- rom
->datasize
;
1270 if ((d
+ l
) > (dest
+ size
)) {
1271 /* Rom size doesn't fit in the destination area. Adjust to avoid
1283 return (d
+ l
) - dest
;
1286 void *rom_ptr(hwaddr addr
, size_t size
)
1290 rom
= find_rom(addr
, size
);
1291 if (!rom
|| !rom
->data
)
1293 return rom
->data
+ (addr
- rom
->addr
);
1296 void hmp_info_roms(Monitor
*mon
, const QDict
*qdict
)
1300 QTAILQ_FOREACH(rom
, &roms
, next
) {
1302 monitor_printf(mon
, "%s"
1303 " size=0x%06zx name=\"%s\"\n",
1304 memory_region_name(rom
->mr
),
1307 } else if (!rom
->fw_file
) {
1308 monitor_printf(mon
, "addr=" TARGET_FMT_plx
1309 " size=0x%06zx mem=%s name=\"%s\"\n",
1310 rom
->addr
, rom
->romsize
,
1311 rom
->isrom
? "rom" : "ram",
1314 monitor_printf(mon
, "fw=%s/%s"
1315 " size=0x%06zx name=\"%s\"\n",
1324 typedef enum HexRecord HexRecord
;
1328 EXT_SEG_ADDR_RECORD
,
1329 START_SEG_ADDR_RECORD
,
1330 EXT_LINEAR_ADDR_RECORD
,
1331 START_LINEAR_ADDR_RECORD
,
1334 /* Each record contains a 16-bit address which is combined with the upper 16
1335 * bits of the implicit "next address" to form a 32-bit address.
1337 #define NEXT_ADDR_MASK 0xffff0000
1339 #define DATA_FIELD_MAX_LEN 0xff
1340 #define LEN_EXCEPT_DATA 0x5
1341 /* 0x5 = sizeof(byte_count) + sizeof(address) + sizeof(record_type) +
1342 * sizeof(checksum) */
1346 uint8_t record_type
;
1347 uint8_t data
[DATA_FIELD_MAX_LEN
];
1351 /* return 0 or -1 if error */
1352 static bool parse_record(HexLine
*line
, uint8_t *our_checksum
, const uint8_t c
,
1353 uint32_t *index
, const bool in_process
)
1355 /* +-------+---------------+-------+---------------------+--------+
1356 * | byte | |record | | |
1357 * | count | address | type | data |checksum|
1358 * +-------+---------------+-------+---------------------+--------+
1360 * |1 byte | 2 bytes |1 byte | 0-255 bytes | 1 byte |
1363 uint32_t idx
= *index
;
1365 if (g_ascii_isspace(c
)) {
1368 if (!g_ascii_isxdigit(c
) || !in_process
) {
1371 value
= g_ascii_xdigit_value(c
);
1372 value
= (idx
& 0x1) ? (value
& 0xf) : (value
<< 4);
1374 line
->byte_count
|= value
;
1375 } else if (2 <= idx
&& idx
< 6) {
1376 line
->address
<<= 4;
1377 line
->address
+= g_ascii_xdigit_value(c
);
1378 } else if (6 <= idx
&& idx
< 8) {
1379 line
->record_type
|= value
;
1380 } else if (8 <= idx
&& idx
< 8 + 2 * line
->byte_count
) {
1381 line
->data
[(idx
- 8) >> 1] |= value
;
1382 } else if (8 + 2 * line
->byte_count
<= idx
&&
1383 idx
< 10 + 2 * line
->byte_count
) {
1384 line
->checksum
|= value
;
1388 *our_checksum
+= value
;
1394 const char *filename
;
1399 uint32_t next_address_to_write
;
1400 uint32_t current_address
;
1401 uint32_t current_rom_index
;
1402 uint32_t rom_start_address
;
1406 /* return size or -1 if error */
1407 static int handle_record_type(HexParser
*parser
)
1409 HexLine
*line
= &(parser
->line
);
1410 switch (line
->record_type
) {
1412 parser
->current_address
=
1413 (parser
->next_address_to_write
& NEXT_ADDR_MASK
) | line
->address
;
1414 /* verify this is a contiguous block of memory */
1415 if (parser
->current_address
!= parser
->next_address_to_write
) {
1416 if (parser
->current_rom_index
!= 0) {
1417 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1418 parser
->current_rom_index
,
1419 parser
->rom_start_address
, parser
->as
);
1421 parser
->rom_start_address
= parser
->current_address
;
1422 parser
->current_rom_index
= 0;
1425 /* copy from line buffer to output bin_buf */
1426 memcpy(parser
->bin_buf
+ parser
->current_rom_index
, line
->data
,
1428 parser
->current_rom_index
+= line
->byte_count
;
1429 parser
->total_size
+= line
->byte_count
;
1430 /* save next address to write */
1431 parser
->next_address_to_write
=
1432 parser
->current_address
+ line
->byte_count
;
1436 if (parser
->current_rom_index
!= 0) {
1437 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1438 parser
->current_rom_index
,
1439 parser
->rom_start_address
, parser
->as
);
1441 return parser
->total_size
;
1442 case EXT_SEG_ADDR_RECORD
:
1443 case EXT_LINEAR_ADDR_RECORD
:
1444 if (line
->byte_count
!= 2 && line
->address
!= 0) {
1448 if (parser
->current_rom_index
!= 0) {
1449 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1450 parser
->current_rom_index
,
1451 parser
->rom_start_address
, parser
->as
);
1454 /* save next address to write,
1455 * in case of non-contiguous block of memory */
1456 parser
->next_address_to_write
= (line
->data
[0] << 12) |
1457 (line
->data
[1] << 4);
1458 if (line
->record_type
== EXT_LINEAR_ADDR_RECORD
) {
1459 parser
->next_address_to_write
<<= 12;
1462 parser
->rom_start_address
= parser
->next_address_to_write
;
1463 parser
->current_rom_index
= 0;
1466 case START_SEG_ADDR_RECORD
:
1467 if (line
->byte_count
!= 4 && line
->address
!= 0) {
1471 /* x86 16-bit CS:IP segmented addressing */
1472 *(parser
->start_addr
) = (((line
->data
[0] << 8) | line
->data
[1]) << 4) +
1473 ((line
->data
[2] << 8) | line
->data
[3]);
1476 case START_LINEAR_ADDR_RECORD
:
1477 if (line
->byte_count
!= 4 && line
->address
!= 0) {
1481 *(parser
->start_addr
) = ldl_be_p(line
->data
);
1488 return parser
->total_size
;
1491 /* return size or -1 if error */
1492 static int parse_hex_blob(const char *filename
, hwaddr
*addr
, uint8_t *hex_blob
,
1493 size_t hex_blob_size
, AddressSpace
*as
)
1495 bool in_process
= false; /* avoid re-enter and
1496 * check whether record begin with ':' */
1497 uint8_t *end
= hex_blob
+ hex_blob_size
;
1498 uint8_t our_checksum
= 0;
1499 uint32_t record_index
= 0;
1500 HexParser parser
= {
1501 .filename
= filename
,
1502 .bin_buf
= g_malloc(hex_blob_size
),
1507 rom_transaction_begin();
1509 for (; hex_blob
< end
; ++hex_blob
) {
1510 switch (*hex_blob
) {
1518 if ((LEN_EXCEPT_DATA
+ parser
.line
.byte_count
) * 2 !=
1520 our_checksum
!= 0) {
1521 parser
.total_size
= -1;
1525 if (handle_record_type(&parser
) == -1) {
1526 parser
.total_size
= -1;
1531 /* start of a new record. */
1533 memset(&parser
.line
, 0, sizeof(HexLine
));
1538 /* decoding lines */
1540 if (!parse_record(&parser
.line
, &our_checksum
, *hex_blob
,
1541 &record_index
, in_process
)) {
1542 parser
.total_size
= -1;
1550 g_free(parser
.bin_buf
);
1551 rom_transaction_end(parser
.total_size
!= -1);
1552 return parser
.total_size
;
1555 /* return size or -1 if error */
1556 int load_targphys_hex_as(const char *filename
, hwaddr
*entry
, AddressSpace
*as
)
1558 gsize hex_blob_size
;
1562 if (!g_file_get_contents(filename
, &hex_blob
, &hex_blob_size
, NULL
)) {
1566 total_size
= parse_hex_blob(filename
, entry
, (uint8_t *)hex_blob
,