2009-09-20 22:58:02 +08:00
|
|
|
#ifndef LOADER_H
|
|
|
|
#define LOADER_H
|
2013-01-14 14:06:25 +08:00
|
|
|
#include "qapi/qmp/qdict.h"
|
2013-04-16 08:24:08 +08:00
|
|
|
#include "hw/nvram/fw_cfg.h"
|
2009-09-20 22:58:02 +08:00
|
|
|
|
|
|
|
/* loader.c */
|
2014-02-06 03:57:55 +08:00
|
|
|
/**
|
|
|
|
* get_image_size: retrieve size of an image file
|
|
|
|
* @filename: Path to the image file
|
|
|
|
*
|
|
|
|
* Returns the size of the image file on success, -1 otherwise.
|
|
|
|
* On error, errno is also set as appropriate.
|
|
|
|
*/
|
2009-09-20 22:58:02 +08:00
|
|
|
int get_image_size(const char *filename);
|
|
|
|
int load_image(const char *filename, uint8_t *addr); /* deprecated */
|
2014-07-21 11:02:03 +08:00
|
|
|
ssize_t load_image_size(const char *filename, void *addr, size_t size);
|
2012-10-23 18:30:10 +08:00
|
|
|
int load_image_targphys(const char *filename, hwaddr,
|
2012-03-13 00:33:25 +08:00
|
|
|
uint64_t max_sz);
|
2016-03-04 19:30:17 +08:00
|
|
|
/**
|
|
|
|
* load_image_mr: load an image into a memory region
|
|
|
|
* @filename: Path to the image file
|
|
|
|
* @mr: Memory Region to load into
|
|
|
|
*
|
|
|
|
* Load the specified file into the memory region.
|
|
|
|
* The file loaded is registered as a ROM, so its contents will be
|
|
|
|
* reinstated whenever the system is reset.
|
|
|
|
* If the file is larger than the memory region's size the call will fail.
|
|
|
|
* Returns -1 on failure, or the size of the file.
|
|
|
|
*/
|
|
|
|
int load_image_mr(const char *filename, MemoryRegion *mr);
|
2014-12-22 20:11:43 +08:00
|
|
|
|
|
|
|
/* This is the limit on the maximum uncompressed image size that
|
|
|
|
* load_image_gzipped_buffer() and load_image_gzipped() will read. It prevents
|
|
|
|
* g_malloc() in those functions from allocating a huge amount of memory.
|
|
|
|
*/
|
|
|
|
#define LOAD_IMAGE_MAX_GUNZIP_BYTES (256 << 20)
|
|
|
|
|
|
|
|
int load_image_gzipped_buffer(const char *filename, uint64_t max_sz,
|
|
|
|
uint8_t **buffer);
|
2014-08-20 01:56:28 +08:00
|
|
|
int load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz);
|
2014-02-04 12:04:18 +08:00
|
|
|
|
|
|
|
#define ELF_LOAD_FAILED -1
|
|
|
|
#define ELF_LOAD_NOT_ELF -2
|
|
|
|
#define ELF_LOAD_WRONG_ARCH -3
|
|
|
|
#define ELF_LOAD_WRONG_ENDIAN -4
|
|
|
|
const char *load_elf_strerror(int error);
|
2016-03-04 19:30:21 +08:00
|
|
|
|
|
|
|
/** load_elf:
|
|
|
|
* @filename: Path of ELF file
|
|
|
|
* @translate_fn: optional function to translate load addresses
|
|
|
|
* @translate_opaque: opaque data passed to @translate_fn
|
|
|
|
* @pentry: Populated with program entry point. Ignored if NULL.
|
|
|
|
* @lowaddr: Populated with lowest loaded address. Ignored if NULL.
|
|
|
|
* @highaddr: Populated with highest loaded address. Ignored if NULL.
|
|
|
|
* @bigendian: Expected ELF endianness. 0 for LE otherwise BE
|
|
|
|
* @elf_machine: Expected ELF machine type
|
|
|
|
* @clear_lsb: Set to mask off LSB of addresses (Some architectures use
|
|
|
|
* this for non-address data)
|
2016-03-04 19:30:21 +08:00
|
|
|
* @data_swab: Set to order of byte swapping for data. 0 for no swap, 1
|
|
|
|
* for swapping bytes within halfwords, 2 for bytes within
|
|
|
|
* words and 3 for within doublewords.
|
2016-03-04 19:30:21 +08:00
|
|
|
*
|
|
|
|
* Load an ELF file's contents to the emulated system's address space.
|
|
|
|
* Clients may optionally specify a callback to perform address
|
|
|
|
* translations. @pentry, @lowaddr and @highaddr are optional pointers
|
|
|
|
* which will be populated with various load information. @bigendian and
|
|
|
|
* @elf_machine give the expected endianness and machine for the ELF the
|
|
|
|
* load will fail if the target ELF does not match. Some architectures
|
|
|
|
* have some architecture-specific behaviours that come into effect when
|
|
|
|
* their particular values for @elf_machine are set.
|
2016-09-23 01:13:07 +08:00
|
|
|
* If @elf_machine is EM_NONE then the machine type will be read from the
|
|
|
|
* ELF header and no checks will be carried out against the machine type.
|
2016-03-04 19:30:21 +08:00
|
|
|
*/
|
|
|
|
|
2010-03-15 04:20:59 +08:00
|
|
|
int load_elf(const char *filename, uint64_t (*translate_fn)(void *, uint64_t),
|
|
|
|
void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
|
|
|
|
uint64_t *highaddr, int big_endian, int elf_machine,
|
2016-03-04 19:30:21 +08:00
|
|
|
int clear_lsb, int data_swab);
|
2016-03-04 19:30:21 +08:00
|
|
|
|
|
|
|
/** load_elf_hdr:
|
|
|
|
* @filename: Path of ELF file
|
|
|
|
* @hdr: Buffer to populate with header data. Header data will not be
|
|
|
|
* filled if set to NULL.
|
|
|
|
* @is64: Set to true if the ELF is 64bit. Ignored if set to NULL
|
|
|
|
* @errp: Populated with an error in failure cases
|
|
|
|
*
|
|
|
|
* Inspect an ELF file's header. Read its full header contents into a
|
|
|
|
* buffer and/or determine if the ELF is 64bit.
|
|
|
|
*/
|
|
|
|
void load_elf_hdr(const char *filename, void *hdr, bool *is64, Error **errp);
|
|
|
|
|
2012-10-23 18:30:10 +08:00
|
|
|
int load_aout(const char *filename, hwaddr addr, int max_sz,
|
|
|
|
int bswap_needed, hwaddr target_page_size);
|
|
|
|
int load_uimage(const char *filename, hwaddr *ep,
|
2014-10-19 11:42:22 +08:00
|
|
|
hwaddr *loadaddr, int *is_linux,
|
|
|
|
uint64_t (*translate_fn)(void *, uint64_t),
|
|
|
|
void *translate_opaque);
|
2009-09-20 22:58:02 +08:00
|
|
|
|
2013-07-09 06:40:01 +08:00
|
|
|
/**
|
|
|
|
* load_ramdisk:
|
|
|
|
* @filename: Path to the ramdisk image
|
|
|
|
* @addr: Memory address to load the ramdisk to
|
|
|
|
* @max_sz: Maximum allowed ramdisk size (for non-u-boot ramdisks)
|
|
|
|
*
|
|
|
|
* Load a ramdisk image with U-Boot header to the specified memory
|
|
|
|
* address.
|
|
|
|
*
|
|
|
|
* Returns the size of the loaded image on success, -1 otherwise.
|
|
|
|
*/
|
|
|
|
int load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz);
|
|
|
|
|
2011-11-17 02:41:56 +08:00
|
|
|
ssize_t read_targphys(const char *name,
|
2012-10-23 18:30:10 +08:00
|
|
|
int fd, hwaddr dst_addr, size_t nbytes);
|
2009-10-07 19:37:06 +08:00
|
|
|
void pstrcpy_targphys(const char *name,
|
2012-10-23 18:30:10 +08:00
|
|
|
hwaddr dest, int buf_size,
|
2009-09-20 22:58:02 +08:00
|
|
|
const char *source);
|
2009-10-01 22:42:33 +08:00
|
|
|
|
2014-03-06 20:57:09 +08:00
|
|
|
extern bool option_rom_has_mr;
|
2014-03-10 00:42:06 +08:00
|
|
|
extern bool rom_file_has_mr;
|
2010-01-08 22:25:38 +08:00
|
|
|
|
|
|
|
int rom_add_file(const char *file, const char *fw_dir,
|
2014-03-06 20:57:09 +08:00
|
|
|
hwaddr addr, int32_t bootindex,
|
2016-09-23 01:13:08 +08:00
|
|
|
bool option_rom, MemoryRegion *mr, AddressSpace *as);
|
2015-03-23 17:24:16 +08:00
|
|
|
MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len,
|
|
|
|
size_t max_len, hwaddr addr,
|
|
|
|
const char *fw_file_name,
|
|
|
|
FWCfgReadCallback fw_callback,
|
|
|
|
void *callback_opaque);
|
2013-02-19 12:41:11 +08:00
|
|
|
int rom_add_elf_program(const char *name, void *data, size_t datasize,
|
2016-09-23 01:13:08 +08:00
|
|
|
size_t romsize, hwaddr addr, AddressSpace *as);
|
2015-06-17 00:07:54 +08:00
|
|
|
int rom_check_and_register_reset(void);
|
2013-04-16 08:24:08 +08:00
|
|
|
void rom_set_fw(FWCfgState *f);
|
2016-04-07 22:12:58 +08:00
|
|
|
void rom_set_order_override(int order);
|
|
|
|
void rom_reset_order_override(void);
|
2012-10-23 18:30:10 +08:00
|
|
|
int rom_copy(uint8_t *dest, hwaddr addr, size_t size);
|
|
|
|
void *rom_ptr(hwaddr addr);
|
2015-02-06 21:18:24 +08:00
|
|
|
void hmp_info_roms(Monitor *mon, const QDict *qdict);
|
2009-10-01 22:42:33 +08:00
|
|
|
|
2010-12-08 19:35:07 +08:00
|
|
|
#define rom_add_file_fixed(_f, _a, _i) \
|
2016-09-23 01:13:08 +08:00
|
|
|
rom_add_file(_f, NULL, _a, _i, false, NULL, NULL)
|
2009-10-01 22:42:33 +08:00
|
|
|
#define rom_add_blob_fixed(_f, _b, _l, _a) \
|
2014-11-17 13:51:50 +08:00
|
|
|
rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL)
|
2016-03-04 19:30:17 +08:00
|
|
|
#define rom_add_file_mr(_f, _mr, _i) \
|
2016-09-23 01:13:08 +08:00
|
|
|
rom_add_file(_f, NULL, 0, _i, false, _mr, NULL)
|
|
|
|
#define rom_add_file_as(_f, _as, _i) \
|
|
|
|
rom_add_file(_f, NULL, 0, _i, false, NULL, _as)
|
2009-10-01 22:42:33 +08:00
|
|
|
|
|
|
|
#define PC_ROM_MIN_VGA 0xc0000
|
|
|
|
#define PC_ROM_MIN_OPTION 0xc8000
|
|
|
|
#define PC_ROM_MAX 0xe0000
|
|
|
|
#define PC_ROM_ALIGN 0x800
|
|
|
|
#define PC_ROM_SIZE (PC_ROM_MAX - PC_ROM_MIN_VGA)
|
|
|
|
|
2009-10-26 19:18:25 +08:00
|
|
|
int rom_add_vga(const char *file);
|
2010-12-08 19:35:07 +08:00
|
|
|
int rom_add_option(const char *file, int32_t bootindex);
|
2009-10-01 22:42:33 +08:00
|
|
|
|
2009-09-20 22:58:02 +08:00
|
|
|
#endif
|