LXR qemu/include/hw/loader.h

   1#ifndef LOADER_H
   2#define LOADER_H
   3#include "qapi/qmp/qdict.h"
   4#include "hw/nvram/fw_cfg.h"
   5
   6/* loader.c */
   7/**
   8 * get_image_size: retrieve size of an image file
   9 * @filename: Path to the image file
  10 *
  11 * Returns the size of the image file on success, -1 otherwise.
  12 * On error, errno is also set as appropriate.
  13 */
  14int get_image_size(const char *filename);
  15int load_image(const char *filename, uint8_t *addr); /* deprecated */
  16ssize_t load_image_size(const char *filename, void *addr, size_t size);
  17
  18/**load_image_targphys_as:
  19 * @filename: Path to the image file
  20 * @addr: Address to load the image to
  21 * @max_sz: The maximum size of the image to load
  22 * @as: The AddressSpace to load the ELF to. The value of address_space_memory
  23 *      is used if nothing is supplied here.
  24 *
  25 * Load a fixed image into memory.
  26 *
  27 * Returns the size of the loaded image on success, -1 otherwise.
  28 */
  29int load_image_targphys_as(const char *filename,
  30                           hwaddr addr, uint64_t max_sz, AddressSpace *as);
  31
  32/** load_image_targphys:
  33 * Same as load_image_targphys_as(), but doesn't allow the caller to specify
  34 * an AddressSpace.
  35 */
  36int load_image_targphys(const char *filename, hwaddr,
  37                        uint64_t max_sz);
  38
  39/**
  40 * load_image_mr: load an image into a memory region
  41 * @filename: Path to the image file
  42 * @mr: Memory Region to load into
  43 *
  44 * Load the specified file into the memory region.
  45 * The file loaded is registered as a ROM, so its contents will be
  46 * reinstated whenever the system is reset.
  47 * If the file is larger than the memory region's size the call will fail.
  48 * Returns -1 on failure, or the size of the file.
  49 */
  50int load_image_mr(const char *filename, MemoryRegion *mr);
  51
  52/* This is the limit on the maximum uncompressed image size that
  53 * load_image_gzipped_buffer() and load_image_gzipped() will read. It prevents
  54 * g_malloc() in those functions from allocating a huge amount of memory.
  55 */
  56#define LOAD_IMAGE_MAX_GUNZIP_BYTES (256 << 20)
  57
  58int load_image_gzipped_buffer(const char *filename, uint64_t max_sz,
  59                              uint8_t **buffer);
  60int load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz);
  61
  62#define ELF_LOAD_FAILED       -1
  63#define ELF_LOAD_NOT_ELF      -2
  64#define ELF_LOAD_WRONG_ARCH   -3
  65#define ELF_LOAD_WRONG_ENDIAN -4
  66const char *load_elf_strerror(int error);
  67
  68/** load_elf_as:
  69 * @filename: Path of ELF file
  70 * @translate_fn: optional function to translate load addresses
  71 * @translate_opaque: opaque data passed to @translate_fn
  72 * @pentry: Populated with program entry point. Ignored if NULL.
  73 * @lowaddr: Populated with lowest loaded address. Ignored if NULL.
  74 * @highaddr: Populated with highest loaded address. Ignored if NULL.
  75 * @bigendian: Expected ELF endianness. 0 for LE otherwise BE
  76 * @elf_machine: Expected ELF machine type
  77 * @clear_lsb: Set to mask off LSB of addresses (Some architectures use
  78 *             this for non-address data)
  79 * @data_swab: Set to order of byte swapping for data. 0 for no swap, 1
  80 *             for swapping bytes within halfwords, 2 for bytes within
  81 *             words and 3 for within doublewords.
  82 * @as: The AddressSpace to load the ELF to. The value of address_space_memory
  83 *      is used if nothing is supplied here.
  84 *
  85 * Load an ELF file's contents to the emulated system's address space.
  86 * Clients may optionally specify a callback to perform address
  87 * translations. @pentry, @lowaddr and @highaddr are optional pointers
  88 * which will be populated with various load information. @bigendian and
  89 * @elf_machine give the expected endianness and machine for the ELF the
  90 * load will fail if the target ELF does not match. Some architectures
  91 * have some architecture-specific behaviours that come into effect when
  92 * their particular values for @elf_machine are set.
  93 * If @elf_machine is EM_NONE then the machine type will be read from the
  94 * ELF header and no checks will be carried out against the machine type.
  95 */
  96int load_elf_as(const char *filename,
  97                uint64_t (*translate_fn)(void *, uint64_t),
  98                void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
  99                uint64_t *highaddr, int big_endian, int elf_machine,
 100                int clear_lsb, int data_swab, AddressSpace *as);
 101
 102/** load_elf:
 103 * Same as load_elf_as(), but doesn't allow the caller to specify an
 104 * AddressSpace.
 105 */
 106int load_elf(const char *filename, uint64_t (*translate_fn)(void *, uint64_t),
 107             void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
 108             uint64_t *highaddr, int big_endian, int elf_machine,
 109             int clear_lsb, int data_swab);
 110
 111/** load_elf_hdr:
 112 * @filename: Path of ELF file
 113 * @hdr: Buffer to populate with header data. Header data will not be
 114 * filled if set to NULL.
 115 * @is64: Set to true if the ELF is 64bit. Ignored if set to NULL
 116 * @errp: Populated with an error in failure cases
 117 *
 118 * Inspect an ELF file's header. Read its full header contents into a
 119 * buffer and/or determine if the ELF is 64bit.
 120 */
 121void load_elf_hdr(const char *filename, void *hdr, bool *is64, Error **errp);
 122
 123int load_aout(const char *filename, hwaddr addr, int max_sz,
 124              int bswap_needed, hwaddr target_page_size);
 125
 126/** load_uimage_as:
 127 * @filename: Path of uimage file
 128 * @ep: Populated with program entry point. Ignored if NULL.
 129 * @loadaddr: Populated with the load address. Ignored if NULL.
 130 * @is_linux: Is set to true if the image loaded is Linux. Ignored if NULL.
 131 * @translate_fn: optional function to translate load addresses
 132 * @translate_opaque: opaque data passed to @translate_fn
 133 * @as: The AddressSpace to load the ELF to. The value of address_space_memory
 134 *      is used if nothing is supplied here.
 135 *
 136 * Loads a u-boot image into memory.
 137 *
 138 * Returns the size of the loaded image on success, -1 otherwise.
 139 */
 140int load_uimage_as(const char *filename, hwaddr *ep,
 141                   hwaddr *loadaddr, int *is_linux,
 142                   uint64_t (*translate_fn)(void *, uint64_t),
 143                   void *translate_opaque, AddressSpace *as);
 144
 145/** load_uimage:
 146 * Same as load_uimage_as(), but doesn't allow the caller to specify an
 147 * AddressSpace.
 148 */
 149int load_uimage(const char *filename, hwaddr *ep,
 150                hwaddr *loadaddr, int *is_linux,
 151                uint64_t (*translate_fn)(void *, uint64_t),
 152                void *translate_opaque);
 153
 154/**
 155 * load_ramdisk:
 156 * @filename: Path to the ramdisk image
 157 * @addr: Memory address to load the ramdisk to
 158 * @max_sz: Maximum allowed ramdisk size (for non-u-boot ramdisks)
 159 *
 160 * Load a ramdisk image with U-Boot header to the specified memory
 161 * address.
 162 *
 163 * Returns the size of the loaded image on success, -1 otherwise.
 164 */
 165int load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz);
 166
 167ssize_t read_targphys(const char *name,
 168                      int fd, hwaddr dst_addr, size_t nbytes);
 169void pstrcpy_targphys(const char *name,
 170                      hwaddr dest, int buf_size,
 171                      const char *source);
 172
 173extern bool option_rom_has_mr;
 174extern bool rom_file_has_mr;
 175
 176int rom_add_file(const char *file, const char *fw_dir,
 177                 hwaddr addr, int32_t bootindex,
 178                 bool option_rom, MemoryRegion *mr, AddressSpace *as);
 179MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len,
 180                           size_t max_len, hwaddr addr,
 181                           const char *fw_file_name,
 182                           FWCfgReadCallback fw_callback,
 183                           void *callback_opaque);
 184int rom_add_elf_program(const char *name, void *data, size_t datasize,
 185                        size_t romsize, hwaddr addr, AddressSpace *as);
 186int rom_check_and_register_reset(void);
 187void rom_set_fw(FWCfgState *f);
 188void rom_set_order_override(int order);
 189void rom_reset_order_override(void);
 190int rom_copy(uint8_t *dest, hwaddr addr, size_t size);
 191void *rom_ptr(hwaddr addr);
 192void hmp_info_roms(Monitor *mon, const QDict *qdict);
 193
 194#define rom_add_file_fixed(_f, _a, _i)          \
 195    rom_add_file(_f, NULL, _a, _i, false, NULL, NULL)
 196#define rom_add_blob_fixed(_f, _b, _l, _a)      \
 197    rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL)
 198#define rom_add_file_mr(_f, _mr, _i)            \
 199    rom_add_file(_f, NULL, 0, _i, false, _mr, NULL)
 200#define rom_add_file_as(_f, _as, _i)            \
 201    rom_add_file(_f, NULL, 0, _i, false, NULL, _as)
 202#define rom_add_file_fixed_as(_f, _a, _i, _as)          \
 203    rom_add_file(_f, NULL, _a, _i, false, NULL, _as)
 204#define rom_add_blob_fixed_as(_f, _b, _l, _a, _as)      \
 205    rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, _as)
 206
 207#define PC_ROM_MIN_VGA     0xc0000
 208#define PC_ROM_MIN_OPTION  0xc8000
 209#define PC_ROM_MAX         0xe0000
 210#define PC_ROM_ALIGN       0x800
 211#define PC_ROM_SIZE        (PC_ROM_MAX - PC_ROM_MIN_VGA)
 212
 213int rom_add_vga(const char *file);
 214int rom_add_option(const char *file, int32_t bootindex);
 215
 216#endif
 217