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 int64_t get_image_size(const char *filename); 14 /** 15 * load_image_size: load an image file into specified buffer 16 * @filename: Path to the image file 17 * @addr: Buffer to load image into 18 * @size: Size of buffer in bytes 19 * 20 * Load an image file from disk into the specified buffer. 21 * If the image is larger than the specified buffer, only 22 * @size bytes are read (this is not considered an error). 23 * 24 * Prefer to use the GLib function g_file_get_contents() rather 25 * than a "get_image_size()/g_malloc()/load_image_size()" sequence. 26 * 27 * Returns the number of bytes read, or -1 on error. On error, 28 * errno is also set as appropriate. 29 */ 30 ssize_t load_image_size(const char *filename, void *addr, size_t size); 31 32 /**load_image_targphys_as: 33 * @filename: Path to the image file 34 * @addr: Address to load the image to 35 * @max_sz: The maximum size of the image to load 36 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 37 * is used if nothing is supplied here. 38 * 39 * Load a fixed image into memory. 40 * 41 * Returns the size of the loaded image on success, -1 otherwise. 42 */ 43 int load_image_targphys_as(const char *filename, 44 hwaddr addr, uint64_t max_sz, AddressSpace *as); 45 46 /**load_targphys_hex_as: 47 * @filename: Path to the .hex file 48 * @entry: Store the entry point given by the .hex file 49 * @as: The AddressSpace to load the .hex file to. The value of 50 * address_space_memory is used if nothing is supplied here. 51 * 52 * Load a fixed .hex file into memory. 53 * 54 * Returns the size of the loaded .hex file on success, -1 otherwise. 55 */ 56 int load_targphys_hex_as(const char *filename, hwaddr *entry, AddressSpace *as); 57 58 /** load_image_targphys: 59 * Same as load_image_targphys_as(), but doesn't allow the caller to specify 60 * an AddressSpace. 61 */ 62 int load_image_targphys(const char *filename, hwaddr, 63 uint64_t max_sz); 64 65 /** 66 * load_image_mr: load an image into a memory region 67 * @filename: Path to the image file 68 * @mr: Memory Region to load into 69 * 70 * Load the specified file into the memory region. 71 * The file loaded is registered as a ROM, so its contents will be 72 * reinstated whenever the system is reset. 73 * If the file is larger than the memory region's size the call will fail. 74 * Returns -1 on failure, or the size of the file. 75 */ 76 int load_image_mr(const char *filename, MemoryRegion *mr); 77 78 /* This is the limit on the maximum uncompressed image size that 79 * load_image_gzipped_buffer() and load_image_gzipped() will read. It prevents 80 * g_malloc() in those functions from allocating a huge amount of memory. 81 */ 82 #define LOAD_IMAGE_MAX_GUNZIP_BYTES (256 << 20) 83 84 int load_image_gzipped_buffer(const char *filename, uint64_t max_sz, 85 uint8_t **buffer); 86 int load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz); 87 88 #define ELF_LOAD_FAILED -1 89 #define ELF_LOAD_NOT_ELF -2 90 #define ELF_LOAD_WRONG_ARCH -3 91 #define ELF_LOAD_WRONG_ENDIAN -4 92 const char *load_elf_strerror(int error); 93 94 /** load_elf_ram_sym: 95 * @filename: Path of ELF file 96 * @translate_fn: optional function to translate load addresses 97 * @translate_opaque: opaque data passed to @translate_fn 98 * @pentry: Populated with program entry point. Ignored if NULL. 99 * @lowaddr: Populated with lowest loaded address. Ignored if NULL. 100 * @highaddr: Populated with highest loaded address. Ignored if NULL. 101 * @bigendian: Expected ELF endianness. 0 for LE otherwise BE 102 * @elf_machine: Expected ELF machine type 103 * @clear_lsb: Set to mask off LSB of addresses (Some architectures use 104 * this for non-address data) 105 * @data_swab: Set to order of byte swapping for data. 0 for no swap, 1 106 * for swapping bytes within halfwords, 2 for bytes within 107 * words and 3 for within doublewords. 108 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 109 * is used if nothing is supplied here. 110 * @load_rom : Load ELF binary as ROM 111 * @sym_cb: Callback function for symbol table entries 112 * 113 * Load an ELF file's contents to the emulated system's address space. 114 * Clients may optionally specify a callback to perform address 115 * translations. @pentry, @lowaddr and @highaddr are optional pointers 116 * which will be populated with various load information. @bigendian and 117 * @elf_machine give the expected endianness and machine for the ELF the 118 * load will fail if the target ELF does not match. Some architectures 119 * have some architecture-specific behaviours that come into effect when 120 * their particular values for @elf_machine are set. 121 * If @elf_machine is EM_NONE then the machine type will be read from the 122 * ELF header and no checks will be carried out against the machine type. 123 */ 124 typedef void (*symbol_fn_t)(const char *st_name, int st_info, 125 uint64_t st_value, uint64_t st_size); 126 127 int load_elf_ram_sym(const char *filename, 128 uint64_t (*translate_fn)(void *, uint64_t), 129 void *translate_opaque, uint64_t *pentry, 130 uint64_t *lowaddr, uint64_t *highaddr, int big_endian, 131 int elf_machine, int clear_lsb, int data_swab, 132 AddressSpace *as, bool load_rom, symbol_fn_t sym_cb); 133 134 /** load_elf_ram: 135 * Same as load_elf_ram_sym(), but doesn't allow the caller to specify a 136 * symbol callback function 137 */ 138 int load_elf_ram(const char *filename, 139 uint64_t (*translate_fn)(void *, uint64_t), 140 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 141 uint64_t *highaddr, int big_endian, int elf_machine, 142 int clear_lsb, int data_swab, AddressSpace *as, 143 bool load_rom); 144 145 /** load_elf_as: 146 * Same as load_elf_ram(), but always loads the elf as ROM 147 */ 148 int load_elf_as(const char *filename, 149 uint64_t (*translate_fn)(void *, uint64_t), 150 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 151 uint64_t *highaddr, int big_endian, int elf_machine, 152 int clear_lsb, int data_swab, AddressSpace *as); 153 154 /** load_elf: 155 * Same as load_elf_as(), but doesn't allow the caller to specify an 156 * AddressSpace. 157 */ 158 int load_elf(const char *filename, uint64_t (*translate_fn)(void *, uint64_t), 159 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 160 uint64_t *highaddr, int big_endian, int elf_machine, 161 int clear_lsb, int data_swab); 162 163 /** load_elf_hdr: 164 * @filename: Path of ELF file 165 * @hdr: Buffer to populate with header data. Header data will not be 166 * filled if set to NULL. 167 * @is64: Set to true if the ELF is 64bit. Ignored if set to NULL 168 * @errp: Populated with an error in failure cases 169 * 170 * Inspect an ELF file's header. Read its full header contents into a 171 * buffer and/or determine if the ELF is 64bit. 172 */ 173 void load_elf_hdr(const char *filename, void *hdr, bool *is64, Error **errp); 174 175 int load_aout(const char *filename, hwaddr addr, int max_sz, 176 int bswap_needed, hwaddr target_page_size); 177 178 /** load_uimage_as: 179 * @filename: Path of uimage file 180 * @ep: Populated with program entry point. Ignored if NULL. 181 * @loadaddr: Populated with the load address. Ignored if NULL. 182 * @is_linux: Is set to true if the image loaded is Linux. Ignored if NULL. 183 * @translate_fn: optional function to translate load addresses 184 * @translate_opaque: opaque data passed to @translate_fn 185 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 186 * is used if nothing is supplied here. 187 * 188 * Loads a u-boot image into memory. 189 * 190 * Returns the size of the loaded image on success, -1 otherwise. 191 */ 192 int load_uimage_as(const char *filename, hwaddr *ep, 193 hwaddr *loadaddr, int *is_linux, 194 uint64_t (*translate_fn)(void *, uint64_t), 195 void *translate_opaque, AddressSpace *as); 196 197 /** load_uimage: 198 * Same as load_uimage_as(), but doesn't allow the caller to specify an 199 * AddressSpace. 200 */ 201 int load_uimage(const char *filename, hwaddr *ep, 202 hwaddr *loadaddr, int *is_linux, 203 uint64_t (*translate_fn)(void *, uint64_t), 204 void *translate_opaque); 205 206 /** 207 * load_ramdisk_as: 208 * @filename: Path to the ramdisk image 209 * @addr: Memory address to load the ramdisk to 210 * @max_sz: Maximum allowed ramdisk size (for non-u-boot ramdisks) 211 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 212 * is used if nothing is supplied here. 213 * 214 * Load a ramdisk image with U-Boot header to the specified memory 215 * address. 216 * 217 * Returns the size of the loaded image on success, -1 otherwise. 218 */ 219 int load_ramdisk_as(const char *filename, hwaddr addr, uint64_t max_sz, 220 AddressSpace *as); 221 222 /** 223 * load_ramdisk: 224 * Same as load_ramdisk_as(), but doesn't allow the caller to specify 225 * an AddressSpace. 226 */ 227 int load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz); 228 229 ssize_t gunzip(void *dst, size_t dstlen, uint8_t *src, size_t srclen); 230 231 ssize_t read_targphys(const char *name, 232 int fd, hwaddr dst_addr, size_t nbytes); 233 void pstrcpy_targphys(const char *name, 234 hwaddr dest, int buf_size, 235 const char *source); 236 237 extern bool option_rom_has_mr; 238 extern bool rom_file_has_mr; 239 240 int rom_add_file(const char *file, const char *fw_dir, 241 hwaddr addr, int32_t bootindex, 242 bool option_rom, MemoryRegion *mr, AddressSpace *as); 243 MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len, 244 size_t max_len, hwaddr addr, 245 const char *fw_file_name, 246 FWCfgCallback fw_callback, 247 void *callback_opaque, AddressSpace *as, 248 bool read_only); 249 int rom_add_elf_program(const char *name, void *data, size_t datasize, 250 size_t romsize, hwaddr addr, AddressSpace *as); 251 int rom_check_and_register_reset(void); 252 void rom_set_fw(FWCfgState *f); 253 void rom_set_order_override(int order); 254 void rom_reset_order_override(void); 255 256 /** 257 * rom_transaction_begin: 258 * 259 * Call this before of a series of rom_add_*() calls. Call 260 * rom_transaction_end() afterwards to commit or abort. These functions are 261 * useful for undoing a series of rom_add_*() calls if image file loading fails 262 * partway through. 263 */ 264 void rom_transaction_begin(void); 265 266 /** 267 * rom_transaction_end: 268 * @commit: true to commit added roms, false to drop added roms 269 * 270 * Call this after a series of rom_add_*() calls. See rom_transaction_begin(). 271 */ 272 void rom_transaction_end(bool commit); 273 274 int rom_copy(uint8_t *dest, hwaddr addr, size_t size); 275 void *rom_ptr(hwaddr addr, size_t size); 276 void hmp_info_roms(Monitor *mon, const QDict *qdict); 277 278 #define rom_add_file_fixed(_f, _a, _i) \ 279 rom_add_file(_f, NULL, _a, _i, false, NULL, NULL) 280 #define rom_add_blob_fixed(_f, _b, _l, _a) \ 281 rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL, NULL, true) 282 #define rom_add_file_mr(_f, _mr, _i) \ 283 rom_add_file(_f, NULL, 0, _i, false, _mr, NULL) 284 #define rom_add_file_as(_f, _as, _i) \ 285 rom_add_file(_f, NULL, 0, _i, false, NULL, _as) 286 #define rom_add_file_fixed_as(_f, _a, _i, _as) \ 287 rom_add_file(_f, NULL, _a, _i, false, NULL, _as) 288 #define rom_add_blob_fixed_as(_f, _b, _l, _a, _as) \ 289 rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL, _as, true) 290 291 #define PC_ROM_MIN_VGA 0xc0000 292 #define PC_ROM_MIN_OPTION 0xc8000 293 #define PC_ROM_MAX 0xe0000 294 #define PC_ROM_ALIGN 0x800 295 #define PC_ROM_SIZE (PC_ROM_MAX - PC_ROM_MIN_VGA) 296 297 int rom_add_vga(const char *file); 298 int rom_add_option(const char *file, int32_t bootindex); 299 300 /* This is the usual maximum in uboot, so if a uImage overflows this, it would 301 * overflow on real hardware too. */ 302 #define UBOOT_MAX_GUNZIP_BYTES (64 << 20) 303 304 #endif 305