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 "qapi/error.h"
48 #include "disas/disas.h"
49 #include "monitor/monitor.h"
50 #include "sysemu/sysemu.h"
51 #include "uboot_image.h"
52 #include "hw/loader.h"
53 #include "hw/nvram/fw_cfg.h"
54 #include "exec/memory.h"
55 #include "exec/address-spaces.h"
56 #include "hw/boards.h"
57 #include "qemu/cutils.h"
61 static int roms_loaded
;
63 /* return the size or -1 if error */
64 int64_t get_image_size(const char *filename
)
68 fd
= open(filename
, O_RDONLY
| O_BINARY
);
71 size
= lseek(fd
, 0, SEEK_END
);
76 /* return the size or -1 if error */
77 ssize_t
load_image_size(const char *filename
, void *addr
, size_t size
)
82 fd
= open(filename
, O_RDONLY
| O_BINARY
);
87 actsize
= read(fd
, addr
, size
);
97 /* read()-like version */
98 ssize_t
read_targphys(const char *name
,
99 int fd
, hwaddr dst_addr
, size_t nbytes
)
104 buf
= g_malloc(nbytes
);
105 did
= read(fd
, buf
, nbytes
);
107 rom_add_blob_fixed("read", buf
, did
, dst_addr
);
112 int load_image_targphys(const char *filename
,
113 hwaddr addr
, uint64_t max_sz
)
115 return load_image_targphys_as(filename
, addr
, max_sz
, NULL
);
118 /* return the size or -1 if error */
119 int load_image_targphys_as(const char *filename
,
120 hwaddr addr
, uint64_t max_sz
, AddressSpace
*as
)
124 size
= get_image_size(filename
);
125 if (size
< 0 || size
> max_sz
) {
129 if (rom_add_file_fixed_as(filename
, addr
, -1, as
) < 0) {
136 int load_image_mr(const char *filename
, MemoryRegion
*mr
)
140 if (!memory_access_is_direct(mr
, false)) {
141 /* Can only load an image into RAM or ROM */
145 size
= get_image_size(filename
);
147 if (size
< 0 || size
> memory_region_size(mr
)) {
151 if (rom_add_file_mr(filename
, mr
, -1) < 0) {
158 void pstrcpy_targphys(const char *name
, hwaddr dest
, int buf_size
,
164 if (buf_size
<= 0) return;
165 nulp
= memchr(source
, 0, buf_size
);
167 rom_add_blob_fixed(name
, source
, (nulp
- source
) + 1, dest
);
169 rom_add_blob_fixed(name
, source
, buf_size
, dest
);
170 ptr
= rom_ptr(dest
+ buf_size
- 1, sizeof(*ptr
));
179 uint32_t a_info
; /* Use macros N_MAGIC, etc for access */
180 uint32_t a_text
; /* length of text, in bytes */
181 uint32_t a_data
; /* length of data, in bytes */
182 uint32_t a_bss
; /* length of uninitialized data area, in bytes */
183 uint32_t a_syms
; /* length of symbol table data in file, in bytes */
184 uint32_t a_entry
; /* start address */
185 uint32_t a_trsize
; /* length of relocation info for text, in bytes */
186 uint32_t a_drsize
; /* length of relocation info for data, in bytes */
189 static void bswap_ahdr(struct exec
*e
)
191 bswap32s(&e
->a_info
);
192 bswap32s(&e
->a_text
);
193 bswap32s(&e
->a_data
);
195 bswap32s(&e
->a_syms
);
196 bswap32s(&e
->a_entry
);
197 bswap32s(&e
->a_trsize
);
198 bswap32s(&e
->a_drsize
);
201 #define N_MAGIC(exec) ((exec).a_info & 0xffff)
206 #define _N_HDROFF(x) (1024 - sizeof (struct exec))
207 #define N_TXTOFF(x) \
208 (N_MAGIC(x) == ZMAGIC ? _N_HDROFF((x)) + sizeof (struct exec) : \
209 (N_MAGIC(x) == QMAGIC ? 0 : sizeof (struct exec)))
210 #define N_TXTADDR(x, target_page_size) (N_MAGIC(x) == QMAGIC ? target_page_size : 0)
211 #define _N_SEGMENT_ROUND(x, target_page_size) (((x) + target_page_size - 1) & ~(target_page_size - 1))
213 #define _N_TXTENDADDR(x, target_page_size) (N_TXTADDR(x, target_page_size)+(x).a_text)
215 #define N_DATADDR(x, target_page_size) \
216 (N_MAGIC(x)==OMAGIC? (_N_TXTENDADDR(x, target_page_size)) \
217 : (_N_SEGMENT_ROUND (_N_TXTENDADDR(x, target_page_size), target_page_size)))
220 int load_aout(const char *filename
, hwaddr addr
, int max_sz
,
221 int bswap_needed
, hwaddr target_page_size
)
228 fd
= open(filename
, O_RDONLY
| O_BINARY
);
232 size
= read(fd
, &e
, sizeof(e
));
245 if (e
.a_text
+ e
.a_data
> max_sz
)
247 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
248 size
= read_targphys(filename
, fd
, addr
, e
.a_text
+ e
.a_data
);
253 if (N_DATADDR(e
, target_page_size
) + e
.a_data
> max_sz
)
255 lseek(fd
, N_TXTOFF(e
), SEEK_SET
);
256 size
= read_targphys(filename
, fd
, addr
, e
.a_text
);
259 ret
= read_targphys(filename
, fd
, addr
+ N_DATADDR(e
, target_page_size
),
277 static void *load_at(int fd
, off_t offset
, size_t size
)
280 if (lseek(fd
, offset
, SEEK_SET
) < 0)
282 ptr
= g_malloc(size
);
283 if (read(fd
, ptr
, size
) != size
) {
294 #define ELF_CLASS ELFCLASS32
298 #define elf_word uint32_t
299 #define elf_sword int32_t
300 #define bswapSZs bswap32s
301 #include "hw/elf_ops.h"
313 #define elfhdr elf64_hdr
314 #define elf_phdr elf64_phdr
315 #define elf_note elf64_note
316 #define elf_shdr elf64_shdr
317 #define elf_sym elf64_sym
318 #define elf_rela elf64_rela
319 #define elf_word uint64_t
320 #define elf_sword int64_t
321 #define bswapSZs bswap64s
323 #include "hw/elf_ops.h"
325 const char *load_elf_strerror(int error
)
330 case ELF_LOAD_FAILED
:
331 return "Failed to load ELF";
332 case ELF_LOAD_NOT_ELF
:
333 return "The image is not ELF";
334 case ELF_LOAD_WRONG_ARCH
:
335 return "The image is from incompatible architecture";
336 case ELF_LOAD_WRONG_ENDIAN
:
337 return "The image has incorrect endianness";
339 return "Unknown error";
343 void load_elf_hdr(const char *filename
, void *hdr
, bool *is64
, Error
**errp
)
346 uint8_t e_ident_local
[EI_NIDENT
];
348 size_t hdr_size
, off
;
356 fd
= open(filename
, O_RDONLY
| O_BINARY
);
358 error_setg_errno(errp
, errno
, "Failed to open file: %s", filename
);
361 if (read(fd
, hdr
, EI_NIDENT
) != EI_NIDENT
) {
362 error_setg_errno(errp
, errno
, "Failed to read file: %s", filename
);
365 if (e_ident
[0] != ELFMAG0
||
366 e_ident
[1] != ELFMAG1
||
367 e_ident
[2] != ELFMAG2
||
368 e_ident
[3] != ELFMAG3
) {
369 error_setg(errp
, "Bad ELF magic");
373 is64l
= e_ident
[EI_CLASS
] == ELFCLASS64
;
374 hdr_size
= is64l
? sizeof(Elf64_Ehdr
) : sizeof(Elf32_Ehdr
);
380 while (hdr
!= e_ident_local
&& off
< hdr_size
) {
381 size_t br
= read(fd
, hdr
+ off
, hdr_size
- off
);
384 error_setg(errp
, "File too short: %s", filename
);
387 error_setg_errno(errp
, errno
, "Failed to read file: %s",
398 /* return < 0 if error, otherwise the number of bytes loaded in memory */
399 int load_elf(const char *filename
,
400 uint64_t (*elf_note_fn
)(void *, void *, bool),
401 uint64_t (*translate_fn
)(void *, uint64_t),
402 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
403 uint64_t *highaddr
, int big_endian
, int elf_machine
,
404 int clear_lsb
, int data_swab
)
406 return load_elf_as(filename
, elf_note_fn
, translate_fn
, translate_opaque
,
407 pentry
, lowaddr
, highaddr
, big_endian
, elf_machine
,
408 clear_lsb
, data_swab
, NULL
);
411 /* return < 0 if error, otherwise the number of bytes loaded in memory */
412 int load_elf_as(const char *filename
,
413 uint64_t (*elf_note_fn
)(void *, void *, bool),
414 uint64_t (*translate_fn
)(void *, uint64_t),
415 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
416 uint64_t *highaddr
, int big_endian
, int elf_machine
,
417 int clear_lsb
, int data_swab
, AddressSpace
*as
)
419 return load_elf_ram(filename
, elf_note_fn
, translate_fn
, translate_opaque
,
420 pentry
, lowaddr
, highaddr
, big_endian
, elf_machine
,
421 clear_lsb
, data_swab
, as
, true);
424 /* return < 0 if error, otherwise the number of bytes loaded in memory */
425 int load_elf_ram(const char *filename
,
426 uint64_t (*elf_note_fn
)(void *, void *, bool),
427 uint64_t (*translate_fn
)(void *, uint64_t),
428 void *translate_opaque
, uint64_t *pentry
, uint64_t *lowaddr
,
429 uint64_t *highaddr
, int big_endian
, int elf_machine
,
430 int clear_lsb
, int data_swab
, AddressSpace
*as
,
433 return load_elf_ram_sym(filename
, elf_note_fn
,
434 translate_fn
, translate_opaque
,
435 pentry
, lowaddr
, highaddr
, big_endian
,
436 elf_machine
, clear_lsb
, data_swab
, as
,
440 /* return < 0 if error, otherwise the number of bytes loaded in memory */
441 int load_elf_ram_sym(const char *filename
,
442 uint64_t (*elf_note_fn
)(void *, void *, bool),
443 uint64_t (*translate_fn
)(void *, uint64_t),
444 void *translate_opaque
, uint64_t *pentry
,
445 uint64_t *lowaddr
, uint64_t *highaddr
, int big_endian
,
446 int elf_machine
, int clear_lsb
, int data_swab
,
447 AddressSpace
*as
, bool load_rom
, symbol_fn_t sym_cb
)
449 int fd
, data_order
, target_data_order
, must_swab
, ret
= ELF_LOAD_FAILED
;
450 uint8_t e_ident
[EI_NIDENT
];
452 fd
= open(filename
, O_RDONLY
| O_BINARY
);
457 if (read(fd
, e_ident
, sizeof(e_ident
)) != sizeof(e_ident
))
459 if (e_ident
[0] != ELFMAG0
||
460 e_ident
[1] != ELFMAG1
||
461 e_ident
[2] != ELFMAG2
||
462 e_ident
[3] != ELFMAG3
) {
463 ret
= ELF_LOAD_NOT_ELF
;
466 #ifdef HOST_WORDS_BIGENDIAN
467 data_order
= ELFDATA2MSB
;
469 data_order
= ELFDATA2LSB
;
471 must_swab
= data_order
!= e_ident
[EI_DATA
];
473 target_data_order
= ELFDATA2MSB
;
475 target_data_order
= ELFDATA2LSB
;
478 if (target_data_order
!= e_ident
[EI_DATA
]) {
479 ret
= ELF_LOAD_WRONG_ENDIAN
;
483 lseek(fd
, 0, SEEK_SET
);
484 if (e_ident
[EI_CLASS
] == ELFCLASS64
) {
485 ret
= load_elf64(filename
, fd
, elf_note_fn
,
486 translate_fn
, translate_opaque
, must_swab
,
487 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
,
488 data_swab
, as
, load_rom
, sym_cb
);
490 ret
= load_elf32(filename
, fd
, elf_note_fn
,
491 translate_fn
, translate_opaque
, must_swab
,
492 pentry
, lowaddr
, highaddr
, elf_machine
, clear_lsb
,
493 data_swab
, as
, load_rom
, sym_cb
);
501 static void bswap_uboot_header(uboot_image_header_t
*hdr
)
503 #ifndef HOST_WORDS_BIGENDIAN
504 bswap32s(&hdr
->ih_magic
);
505 bswap32s(&hdr
->ih_hcrc
);
506 bswap32s(&hdr
->ih_time
);
507 bswap32s(&hdr
->ih_size
);
508 bswap32s(&hdr
->ih_load
);
509 bswap32s(&hdr
->ih_ep
);
510 bswap32s(&hdr
->ih_dcrc
);
515 #define ZALLOC_ALIGNMENT 16
517 static void *zalloc(void *x
, unsigned items
, unsigned size
)
522 size
= (size
+ ZALLOC_ALIGNMENT
- 1) & ~(ZALLOC_ALIGNMENT
- 1);
529 static void zfree(void *x
, void *addr
)
536 #define EXTRA_FIELD 4
539 #define RESERVED 0xe0
543 ssize_t
gunzip(void *dst
, size_t dstlen
, uint8_t *src
, size_t srclen
)
552 if (src
[2] != DEFLATED
|| (flags
& RESERVED
) != 0) {
553 puts ("Error: Bad gzipped data\n");
556 if ((flags
& EXTRA_FIELD
) != 0)
557 i
= 12 + src
[10] + (src
[11] << 8);
558 if ((flags
& ORIG_NAME
) != 0)
559 while (src
[i
++] != 0)
561 if ((flags
& COMMENT
) != 0)
562 while (src
[i
++] != 0)
564 if ((flags
& HEAD_CRC
) != 0)
567 puts ("Error: gunzip out of data in header\n");
574 r
= inflateInit2(&s
, -MAX_WBITS
);
576 printf ("Error: inflateInit2() returned %d\n", r
);
580 s
.avail_in
= srclen
- i
;
582 s
.avail_out
= dstlen
;
583 r
= inflate(&s
, Z_FINISH
);
584 if (r
!= Z_OK
&& r
!= Z_STREAM_END
) {
585 printf ("Error: inflate() returned %d\n", r
);
588 dstbytes
= s
.next_out
- (unsigned char *) dst
;
594 /* Load a U-Boot image. */
595 static int load_uboot_image(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
596 int *is_linux
, uint8_t image_type
,
597 uint64_t (*translate_fn
)(void *, uint64_t),
598 void *translate_opaque
, AddressSpace
*as
)
603 uboot_image_header_t h
;
604 uboot_image_header_t
*hdr
= &h
;
605 uint8_t *data
= NULL
;
607 int do_uncompress
= 0;
609 fd
= open(filename
, O_RDONLY
| O_BINARY
);
613 size
= read(fd
, hdr
, sizeof(uboot_image_header_t
));
614 if (size
< sizeof(uboot_image_header_t
)) {
618 bswap_uboot_header(hdr
);
620 if (hdr
->ih_magic
!= IH_MAGIC
)
623 if (hdr
->ih_type
!= image_type
) {
624 if (!(image_type
== IH_TYPE_KERNEL
&&
625 hdr
->ih_type
== IH_TYPE_KERNEL_NOLOAD
)) {
626 fprintf(stderr
, "Wrong image type %d, expected %d\n", hdr
->ih_type
,
632 /* TODO: Implement other image types. */
633 switch (hdr
->ih_type
) {
634 case IH_TYPE_KERNEL_NOLOAD
:
635 if (!loadaddr
|| *loadaddr
== LOAD_UIMAGE_LOADADDR_INVALID
) {
636 fprintf(stderr
, "this image format (kernel_noload) cannot be "
637 "loaded on this machine type");
641 hdr
->ih_load
= *loadaddr
+ sizeof(*hdr
);
642 hdr
->ih_ep
+= hdr
->ih_load
;
645 address
= hdr
->ih_load
;
647 address
= translate_fn(translate_opaque
, address
);
650 *loadaddr
= hdr
->ih_load
;
653 switch (hdr
->ih_comp
) {
661 "Unable to load u-boot images with compression type %d\n",
670 /* TODO: Check CPU type. */
672 if (hdr
->ih_os
== IH_OS_LINUX
) {
680 case IH_TYPE_RAMDISK
:
684 fprintf(stderr
, "Unsupported u-boot image type %d\n", hdr
->ih_type
);
688 data
= g_malloc(hdr
->ih_size
);
690 if (read(fd
, data
, hdr
->ih_size
) != hdr
->ih_size
) {
691 fprintf(stderr
, "Error reading file\n");
696 uint8_t *compressed_data
;
700 compressed_data
= data
;
701 max_bytes
= UBOOT_MAX_GUNZIP_BYTES
;
702 data
= g_malloc(max_bytes
);
704 bytes
= gunzip(data
, max_bytes
, compressed_data
, hdr
->ih_size
);
705 g_free(compressed_data
);
707 fprintf(stderr
, "Unable to decompress gzipped image!\n");
710 hdr
->ih_size
= bytes
;
713 rom_add_blob_fixed_as(filename
, data
, hdr
->ih_size
, address
, as
);
723 int load_uimage(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
725 uint64_t (*translate_fn
)(void *, uint64_t),
726 void *translate_opaque
)
728 return load_uboot_image(filename
, ep
, loadaddr
, is_linux
, IH_TYPE_KERNEL
,
729 translate_fn
, translate_opaque
, NULL
);
732 int load_uimage_as(const char *filename
, hwaddr
*ep
, hwaddr
*loadaddr
,
734 uint64_t (*translate_fn
)(void *, uint64_t),
735 void *translate_opaque
, AddressSpace
*as
)
737 return load_uboot_image(filename
, ep
, loadaddr
, is_linux
, IH_TYPE_KERNEL
,
738 translate_fn
, translate_opaque
, as
);
741 /* Load a ramdisk. */
742 int load_ramdisk(const char *filename
, hwaddr addr
, uint64_t max_sz
)
744 return load_ramdisk_as(filename
, addr
, max_sz
, NULL
);
747 int load_ramdisk_as(const char *filename
, hwaddr addr
, uint64_t max_sz
,
750 return load_uboot_image(filename
, NULL
, &addr
, NULL
, IH_TYPE_RAMDISK
,
754 /* Load a gzip-compressed kernel to a dynamically allocated buffer. */
755 int load_image_gzipped_buffer(const char *filename
, uint64_t max_sz
,
758 uint8_t *compressed_data
= NULL
;
759 uint8_t *data
= NULL
;
764 if (!g_file_get_contents(filename
, (char **) &compressed_data
, &len
,
769 /* Is it a gzip-compressed file? */
771 compressed_data
[0] != 0x1f ||
772 compressed_data
[1] != 0x8b) {
776 if (max_sz
> LOAD_IMAGE_MAX_GUNZIP_BYTES
) {
777 max_sz
= LOAD_IMAGE_MAX_GUNZIP_BYTES
;
780 data
= g_malloc(max_sz
);
781 bytes
= gunzip(data
, max_sz
, compressed_data
, len
);
783 fprintf(stderr
, "%s: unable to decompress gzipped kernel file\n",
788 /* trim to actual size and return to caller */
789 *buffer
= g_realloc(data
, bytes
);
791 /* ownership has been transferred to caller */
795 g_free(compressed_data
);
800 /* Load a gzip-compressed kernel. */
801 int load_image_gzipped(const char *filename
, hwaddr addr
, uint64_t max_sz
)
806 bytes
= load_image_gzipped_buffer(filename
, max_sz
, &data
);
808 rom_add_blob_fixed(filename
, data
, bytes
, addr
);
815 * Functions for reboot-persistent memory regions.
816 * - used for vga bios and option roms.
817 * - also linux kernel (-kernel / -initrd).
820 typedef struct Rom Rom
;
826 /* datasize is the amount of memory allocated in "data". If datasize is less
827 * than romsize, it means that the area from datasize to romsize is filled
843 QTAILQ_ENTRY(Rom
) next
;
846 static FWCfgState
*fw_cfg
;
847 static QTAILQ_HEAD(, Rom
) roms
= QTAILQ_HEAD_INITIALIZER(roms
);
849 /* rom->data must be heap-allocated (do not use with rom_add_elf_program()) */
850 static void rom_free(Rom
*rom
)
856 g_free(rom
->fw_file
);
860 static inline bool rom_order_compare(Rom
*rom
, Rom
*item
)
862 return ((uintptr_t)(void *)rom
->as
> (uintptr_t)(void *)item
->as
) ||
863 (rom
->as
== item
->as
&& rom
->addr
>= item
->addr
);
866 static void rom_insert(Rom
*rom
)
871 hw_error ("ROM images must be loaded at startup\n");
874 /* The user didn't specify an address space, this is the default */
876 rom
->as
= &address_space_memory
;
879 rom
->committed
= false;
881 /* List is ordered by load address in the same address space */
882 QTAILQ_FOREACH(item
, &roms
, next
) {
883 if (rom_order_compare(rom
, item
)) {
886 QTAILQ_INSERT_BEFORE(item
, rom
, next
);
889 QTAILQ_INSERT_TAIL(&roms
, rom
, next
);
892 static void fw_cfg_resized(const char *id
, uint64_t length
, void *host
)
895 fw_cfg_modify_file(fw_cfg
, id
+ strlen("/rom@"), host
, length
);
899 static void *rom_set_mr(Rom
*rom
, Object
*owner
, const char *name
, bool ro
)
903 rom
->mr
= g_malloc(sizeof(*rom
->mr
));
904 memory_region_init_resizeable_ram(rom
->mr
, owner
, name
,
905 rom
->datasize
, rom
->romsize
,
908 memory_region_set_readonly(rom
->mr
, ro
);
909 vmstate_register_ram_global(rom
->mr
);
911 data
= memory_region_get_ram_ptr(rom
->mr
);
912 memcpy(data
, rom
->data
, rom
->datasize
);
917 int rom_add_file(const char *file
, const char *fw_dir
,
918 hwaddr addr
, int32_t bootindex
,
919 bool option_rom
, MemoryRegion
*mr
,
922 MachineClass
*mc
= MACHINE_GET_CLASS(qdev_get_machine());
928 fprintf(stderr
, "Specifying an Address Space and Memory Region is " \
929 "not valid when loading a rom\n");
930 /* We haven't allocated anything so we don't need any cleanup */
934 rom
= g_malloc0(sizeof(*rom
));
935 rom
->name
= g_strdup(file
);
936 rom
->path
= qemu_find_file(QEMU_FILE_TYPE_BIOS
, rom
->name
);
938 if (rom
->path
== NULL
) {
939 rom
->path
= g_strdup(file
);
942 fd
= open(rom
->path
, O_RDONLY
| O_BINARY
);
944 fprintf(stderr
, "Could not open option rom '%s': %s\n",
945 rom
->path
, strerror(errno
));
950 rom
->fw_dir
= g_strdup(fw_dir
);
951 rom
->fw_file
= g_strdup(file
);
954 rom
->romsize
= lseek(fd
, 0, SEEK_END
);
955 if (rom
->romsize
== -1) {
956 fprintf(stderr
, "rom: file %-20s: get size error: %s\n",
957 rom
->name
, strerror(errno
));
961 rom
->datasize
= rom
->romsize
;
962 rom
->data
= g_malloc0(rom
->datasize
);
963 lseek(fd
, 0, SEEK_SET
);
964 rc
= read(fd
, rom
->data
, rom
->datasize
);
965 if (rc
!= rom
->datasize
) {
966 fprintf(stderr
, "rom: file %-20s: read error: rc=%d (expected %zd)\n",
967 rom
->name
, rc
, rom
->datasize
);
972 if (rom
->fw_file
&& fw_cfg
) {
973 const char *basename
;
974 char fw_file_name
[FW_CFG_MAX_FILE_PATH
];
977 basename
= strrchr(rom
->fw_file
, '/');
981 basename
= rom
->fw_file
;
983 snprintf(fw_file_name
, sizeof(fw_file_name
), "%s/%s", rom
->fw_dir
,
985 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
987 if ((!option_rom
|| mc
->option_rom_has_mr
) && mc
->rom_file_has_mr
) {
988 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
, true);
993 fw_cfg_add_file(fw_cfg
, fw_file_name
, data
, rom
->romsize
);
997 snprintf(devpath
, sizeof(devpath
), "/rom@%s", file
);
999 snprintf(devpath
, sizeof(devpath
), "/rom@" TARGET_FMT_plx
, addr
);
1003 add_boot_device_path(bootindex
, NULL
, devpath
);
1014 MemoryRegion
*rom_add_blob(const char *name
, const void *blob
, size_t len
,
1015 size_t max_len
, hwaddr addr
, const char *fw_file_name
,
1016 FWCfgCallback fw_callback
, void *callback_opaque
,
1017 AddressSpace
*as
, bool read_only
)
1019 MachineClass
*mc
= MACHINE_GET_CLASS(qdev_get_machine());
1021 MemoryRegion
*mr
= NULL
;
1023 rom
= g_malloc0(sizeof(*rom
));
1024 rom
->name
= g_strdup(name
);
1027 rom
->romsize
= max_len
? max_len
: len
;
1028 rom
->datasize
= len
;
1029 rom
->data
= g_malloc0(rom
->datasize
);
1030 memcpy(rom
->data
, blob
, len
);
1032 if (fw_file_name
&& fw_cfg
) {
1037 snprintf(devpath
, sizeof(devpath
), "/rom@%s", fw_file_name
);
1039 snprintf(devpath
, sizeof(devpath
), "/ram@%s", fw_file_name
);
1042 if (mc
->rom_file_has_mr
) {
1043 data
= rom_set_mr(rom
, OBJECT(fw_cfg
), devpath
, read_only
);
1049 fw_cfg_add_file_callback(fw_cfg
, fw_file_name
,
1050 fw_callback
, NULL
, callback_opaque
,
1051 data
, rom
->datasize
, read_only
);
1056 /* This function is specific for elf program because we don't need to allocate
1057 * all the rom. We just allocate the first part and the rest is just zeros. This
1058 * is why romsize and datasize are different. Also, this function seize the
1059 * memory ownership of "data", so we don't have to allocate and copy the buffer.
1061 int rom_add_elf_program(const char *name
, void *data
, size_t datasize
,
1062 size_t romsize
, hwaddr addr
, AddressSpace
*as
)
1066 rom
= g_malloc0(sizeof(*rom
));
1067 rom
->name
= g_strdup(name
);
1069 rom
->datasize
= datasize
;
1070 rom
->romsize
= romsize
;
1077 int rom_add_vga(const char *file
)
1079 return rom_add_file(file
, "vgaroms", 0, -1, true, NULL
, NULL
);
1082 int rom_add_option(const char *file
, int32_t bootindex
)
1084 return rom_add_file(file
, "genroms", 0, bootindex
, true, NULL
, NULL
);
1087 static void rom_reset(void *unused
)
1091 QTAILQ_FOREACH(rom
, &roms
, next
) {
1095 if (rom
->data
== NULL
) {
1099 void *host
= memory_region_get_ram_ptr(rom
->mr
);
1100 memcpy(host
, rom
->data
, rom
->datasize
);
1102 address_space_write_rom(rom
->as
, rom
->addr
, MEMTXATTRS_UNSPECIFIED
,
1103 rom
->data
, rom
->datasize
);
1106 /* rom needs to be written only once */
1111 * The rom loader is really on the same level as firmware in the guest
1112 * shadowing a ROM into RAM. Such a shadowing mechanism needs to ensure
1113 * that the instruction cache for that new region is clear, so that the
1114 * CPU definitely fetches its instructions from the just written data.
1116 cpu_flush_icache_range(rom
->addr
, rom
->datasize
);
1120 int rom_check_and_register_reset(void)
1123 MemoryRegionSection section
;
1125 AddressSpace
*as
= NULL
;
1127 QTAILQ_FOREACH(rom
, &roms
, next
) {
1132 if ((addr
> rom
->addr
) && (as
== rom
->as
)) {
1133 fprintf(stderr
, "rom: requested regions overlap "
1134 "(rom %s. free=0x" TARGET_FMT_plx
1135 ", addr=0x" TARGET_FMT_plx
")\n",
1136 rom
->name
, addr
, rom
->addr
);
1140 addr
+= rom
->romsize
;
1143 section
= memory_region_find(rom
->mr
? rom
->mr
: get_system_memory(),
1145 rom
->isrom
= int128_nz(section
.size
) && memory_region_is_rom(section
.mr
);
1146 memory_region_unref(section
.mr
);
1148 qemu_register_reset(rom_reset
, NULL
);
1153 void rom_set_fw(FWCfgState
*f
)
1158 void rom_set_order_override(int order
)
1162 fw_cfg_set_order_override(fw_cfg
, order
);
1165 void rom_reset_order_override(void)
1169 fw_cfg_reset_order_override(fw_cfg
);
1172 void rom_transaction_begin(void)
1176 /* Ignore ROMs added without the transaction API */
1177 QTAILQ_FOREACH(rom
, &roms
, next
) {
1178 rom
->committed
= true;
1182 void rom_transaction_end(bool commit
)
1187 QTAILQ_FOREACH_SAFE(rom
, &roms
, next
, tmp
) {
1188 if (rom
->committed
) {
1192 rom
->committed
= true;
1194 QTAILQ_REMOVE(&roms
, rom
, next
);
1200 static Rom
*find_rom(hwaddr addr
, size_t size
)
1204 QTAILQ_FOREACH(rom
, &roms
, next
) {
1211 if (rom
->addr
> addr
) {
1214 if (rom
->addr
+ rom
->romsize
< addr
+ size
) {
1223 * Copies memory from registered ROMs to dest. Any memory that is contained in
1224 * a ROM between addr and addr + size is copied. Note that this can involve
1225 * multiple ROMs, which need not start at addr and need not end at addr + size.
1227 int rom_copy(uint8_t *dest
, hwaddr addr
, size_t size
)
1229 hwaddr end
= addr
+ size
;
1230 uint8_t *s
, *d
= dest
;
1234 QTAILQ_FOREACH(rom
, &roms
, next
) {
1241 if (rom
->addr
+ rom
->romsize
< addr
) {
1244 if (rom
->addr
> end
) {
1248 d
= dest
+ (rom
->addr
- addr
);
1252 if ((d
+ l
) > (dest
+ size
)) {
1260 if (rom
->romsize
> rom
->datasize
) {
1261 /* If datasize is less than romsize, it means that we didn't
1262 * allocate all the ROM because the trailing data are only zeros.
1266 l
= rom
->romsize
- rom
->datasize
;
1268 if ((d
+ l
) > (dest
+ size
)) {
1269 /* Rom size doesn't fit in the destination area. Adjust to avoid
1281 return (d
+ l
) - dest
;
1284 void *rom_ptr(hwaddr addr
, size_t size
)
1288 rom
= find_rom(addr
, size
);
1289 if (!rom
|| !rom
->data
)
1291 return rom
->data
+ (addr
- rom
->addr
);
1294 void hmp_info_roms(Monitor
*mon
, const QDict
*qdict
)
1298 QTAILQ_FOREACH(rom
, &roms
, next
) {
1300 monitor_printf(mon
, "%s"
1301 " size=0x%06zx name=\"%s\"\n",
1302 memory_region_name(rom
->mr
),
1305 } else if (!rom
->fw_file
) {
1306 monitor_printf(mon
, "addr=" TARGET_FMT_plx
1307 " size=0x%06zx mem=%s name=\"%s\"\n",
1308 rom
->addr
, rom
->romsize
,
1309 rom
->isrom
? "rom" : "ram",
1312 monitor_printf(mon
, "fw=%s/%s"
1313 " size=0x%06zx name=\"%s\"\n",
1322 typedef enum HexRecord HexRecord
;
1326 EXT_SEG_ADDR_RECORD
,
1327 START_SEG_ADDR_RECORD
,
1328 EXT_LINEAR_ADDR_RECORD
,
1329 START_LINEAR_ADDR_RECORD
,
1332 /* Each record contains a 16-bit address which is combined with the upper 16
1333 * bits of the implicit "next address" to form a 32-bit address.
1335 #define NEXT_ADDR_MASK 0xffff0000
1337 #define DATA_FIELD_MAX_LEN 0xff
1338 #define LEN_EXCEPT_DATA 0x5
1339 /* 0x5 = sizeof(byte_count) + sizeof(address) + sizeof(record_type) +
1340 * sizeof(checksum) */
1344 uint8_t record_type
;
1345 uint8_t data
[DATA_FIELD_MAX_LEN
];
1349 /* return 0 or -1 if error */
1350 static bool parse_record(HexLine
*line
, uint8_t *our_checksum
, const uint8_t c
,
1351 uint32_t *index
, const bool in_process
)
1353 /* +-------+---------------+-------+---------------------+--------+
1354 * | byte | |record | | |
1355 * | count | address | type | data |checksum|
1356 * +-------+---------------+-------+---------------------+--------+
1358 * |1 byte | 2 bytes |1 byte | 0-255 bytes | 1 byte |
1361 uint32_t idx
= *index
;
1363 if (g_ascii_isspace(c
)) {
1366 if (!g_ascii_isxdigit(c
) || !in_process
) {
1369 value
= g_ascii_xdigit_value(c
);
1370 value
= (idx
& 0x1) ? (value
& 0xf) : (value
<< 4);
1372 line
->byte_count
|= value
;
1373 } else if (2 <= idx
&& idx
< 6) {
1374 line
->address
<<= 4;
1375 line
->address
+= g_ascii_xdigit_value(c
);
1376 } else if (6 <= idx
&& idx
< 8) {
1377 line
->record_type
|= value
;
1378 } else if (8 <= idx
&& idx
< 8 + 2 * line
->byte_count
) {
1379 line
->data
[(idx
- 8) >> 1] |= value
;
1380 } else if (8 + 2 * line
->byte_count
<= idx
&&
1381 idx
< 10 + 2 * line
->byte_count
) {
1382 line
->checksum
|= value
;
1386 *our_checksum
+= value
;
1392 const char *filename
;
1397 uint32_t next_address_to_write
;
1398 uint32_t current_address
;
1399 uint32_t current_rom_index
;
1400 uint32_t rom_start_address
;
1404 /* return size or -1 if error */
1405 static int handle_record_type(HexParser
*parser
)
1407 HexLine
*line
= &(parser
->line
);
1408 switch (line
->record_type
) {
1410 parser
->current_address
=
1411 (parser
->next_address_to_write
& NEXT_ADDR_MASK
) | line
->address
;
1412 /* verify this is a contiguous block of memory */
1413 if (parser
->current_address
!= parser
->next_address_to_write
) {
1414 if (parser
->current_rom_index
!= 0) {
1415 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1416 parser
->current_rom_index
,
1417 parser
->rom_start_address
, parser
->as
);
1419 parser
->rom_start_address
= parser
->current_address
;
1420 parser
->current_rom_index
= 0;
1423 /* copy from line buffer to output bin_buf */
1424 memcpy(parser
->bin_buf
+ parser
->current_rom_index
, line
->data
,
1426 parser
->current_rom_index
+= line
->byte_count
;
1427 parser
->total_size
+= line
->byte_count
;
1428 /* save next address to write */
1429 parser
->next_address_to_write
=
1430 parser
->current_address
+ line
->byte_count
;
1434 if (parser
->current_rom_index
!= 0) {
1435 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1436 parser
->current_rom_index
,
1437 parser
->rom_start_address
, parser
->as
);
1439 return parser
->total_size
;
1440 case EXT_SEG_ADDR_RECORD
:
1441 case EXT_LINEAR_ADDR_RECORD
:
1442 if (line
->byte_count
!= 2 && line
->address
!= 0) {
1446 if (parser
->current_rom_index
!= 0) {
1447 rom_add_blob_fixed_as(parser
->filename
, parser
->bin_buf
,
1448 parser
->current_rom_index
,
1449 parser
->rom_start_address
, parser
->as
);
1452 /* save next address to write,
1453 * in case of non-contiguous block of memory */
1454 parser
->next_address_to_write
= (line
->data
[0] << 12) |
1455 (line
->data
[1] << 4);
1456 if (line
->record_type
== EXT_LINEAR_ADDR_RECORD
) {
1457 parser
->next_address_to_write
<<= 12;
1460 parser
->rom_start_address
= parser
->next_address_to_write
;
1461 parser
->current_rom_index
= 0;
1464 case START_SEG_ADDR_RECORD
:
1465 if (line
->byte_count
!= 4 && line
->address
!= 0) {
1469 /* x86 16-bit CS:IP segmented addressing */
1470 *(parser
->start_addr
) = (((line
->data
[0] << 8) | line
->data
[1]) << 4) +
1471 ((line
->data
[2] << 8) | line
->data
[3]);
1474 case START_LINEAR_ADDR_RECORD
:
1475 if (line
->byte_count
!= 4 && line
->address
!= 0) {
1479 *(parser
->start_addr
) = ldl_be_p(line
->data
);
1486 return parser
->total_size
;
1489 /* return size or -1 if error */
1490 static int parse_hex_blob(const char *filename
, hwaddr
*addr
, uint8_t *hex_blob
,
1491 size_t hex_blob_size
, AddressSpace
*as
)
1493 bool in_process
= false; /* avoid re-enter and
1494 * check whether record begin with ':' */
1495 uint8_t *end
= hex_blob
+ hex_blob_size
;
1496 uint8_t our_checksum
= 0;
1497 uint32_t record_index
= 0;
1498 HexParser parser
= {
1499 .filename
= filename
,
1500 .bin_buf
= g_malloc(hex_blob_size
),
1505 rom_transaction_begin();
1507 for (; hex_blob
< end
; ++hex_blob
) {
1508 switch (*hex_blob
) {
1516 if ((LEN_EXCEPT_DATA
+ parser
.line
.byte_count
) * 2 !=
1518 our_checksum
!= 0) {
1519 parser
.total_size
= -1;
1523 if (handle_record_type(&parser
) == -1) {
1524 parser
.total_size
= -1;
1529 /* start of a new record. */
1531 memset(&parser
.line
, 0, sizeof(HexLine
));
1536 /* decoding lines */
1538 if (!parse_record(&parser
.line
, &our_checksum
, *hex_blob
,
1539 &record_index
, in_process
)) {
1540 parser
.total_size
= -1;
1548 g_free(parser
.bin_buf
);
1549 rom_transaction_end(parser
.total_size
!= -1);
1550 return parser
.total_size
;
1553 /* return size or -1 if error */
1554 int load_targphys_hex_as(const char *filename
, hwaddr
*entry
, AddressSpace
*as
)
1556 gsize hex_blob_size
;
1560 if (!g_file_get_contents(filename
, &hex_blob
, &hex_blob_size
, NULL
)) {
1564 total_size
= parse_hex_blob(filename
, entry
, (uint8_t *)hex_blob
,