include/hw/loader.h

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