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 ssize_t 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 ssize_t load_targphys_hex_as(const char *filename, hwaddr *entry, 57 AddressSpace *as); 58 59 /** load_image_targphys: 60 * Same as load_image_targphys_as(), but doesn't allow the caller to specify 61 * an AddressSpace. 62 */ 63 ssize_t load_image_targphys(const char *filename, hwaddr, 64 uint64_t max_sz); 65 66 /** 67 * load_image_mr: load an image into a memory region 68 * @filename: Path to the image file 69 * @mr: Memory Region to load into 70 * 71 * Load the specified file into the memory region. 72 * The file loaded is registered as a ROM, so its contents will be 73 * reinstated whenever the system is reset. 74 * If the file is larger than the memory region's size the call will fail. 75 * Returns -1 on failure, or the size of the file. 76 */ 77 ssize_t load_image_mr(const char *filename, MemoryRegion *mr); 78 79 /* This is the limit on the maximum uncompressed image size that 80 * load_image_gzipped_buffer() will read. It prevents 81 * g_malloc() in those functions from allocating a huge amount of memory. 82 */ 83 #define LOAD_IMAGE_MAX_GUNZIP_BYTES (256 << 20) 84 85 ssize_t load_image_gzipped_buffer(const char *filename, uint64_t max_sz, 86 uint8_t **buffer); 87 /** 88 * unpack_efi_zboot_image: 89 * @buffer: pointer to a variable holding the address of a buffer containing the 90 * image 91 * @size: pointer to a variable holding the size of the buffer 92 * 93 * Check whether the buffer contains a EFI zboot image, and if it does, extract 94 * the compressed payload and decompress it into a new buffer. If successful, 95 * the old buffer is freed, and the *buffer and size variables pointed to by the 96 * function arguments are updated to refer to the newly populated buffer. 97 * 98 * Returns 0 if the image could not be identified as a EFI zboot image. 99 * Returns -1 if the buffer contents were identified as a EFI zboot image, but 100 * unpacking failed for any reason. 101 * Returns the size of the decompressed payload if decompression was performed 102 * successfully. 103 */ 104 ssize_t unpack_efi_zboot_image(uint8_t **buffer, ssize_t *size); 105 106 #define ELF_LOAD_FAILED -1 107 #define ELF_LOAD_NOT_ELF -2 108 #define ELF_LOAD_WRONG_ARCH -3 109 #define ELF_LOAD_WRONG_ENDIAN -4 110 #define ELF_LOAD_TOO_BIG -5 111 const char *load_elf_strerror(ssize_t error); 112 113 /** load_elf_ram_sym: 114 * @filename: Path of ELF file 115 * @elf_note_fn: optional function to parse ELF Note type 116 * passed via @translate_opaque 117 * @translate_fn: optional function to translate load addresses 118 * @translate_opaque: opaque data passed to @translate_fn 119 * @pentry: Populated with program entry point. Ignored if NULL. 120 * @lowaddr: Populated with lowest loaded address. Ignored if NULL. 121 * @highaddr: Populated with highest loaded address. Ignored if NULL. 122 * @pflags: Populated with ELF processor-specific flags. Ignore if NULL. 123 * @elf_data_order: Expected ELF endianness (ELFDATA2LSB or ELFDATA2MSB). 124 * @elf_machine: Expected ELF machine type 125 * @clear_lsb: Set to mask off LSB of addresses (Some architectures use 126 * this for non-address data) 127 * @data_swab: Set to order of byte swapping for data. 0 for no swap, 1 128 * for swapping bytes within halfwords, 2 for bytes within 129 * words and 3 for within doublewords. 130 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 131 * is used if nothing is supplied here. 132 * @load_rom : Load ELF binary as ROM 133 * @sym_cb: Callback function for symbol table entries 134 * 135 * Load an ELF file's contents to the emulated system's address space. 136 * Clients may optionally specify a callback to perform address 137 * translations. @pentry, @lowaddr and @highaddr are optional pointers 138 * which will be populated with various load information. @bigendian and 139 * @elf_machine give the expected endianness and machine for the ELF the 140 * load will fail if the target ELF does not match. Some architectures 141 * have some architecture-specific behaviours that come into effect when 142 * their particular values for @elf_machine are set. 143 * If @elf_machine is EM_NONE then the machine type will be read from the 144 * ELF header and no checks will be carried out against the machine type. 145 */ 146 typedef void (*symbol_fn_t)(const char *st_name, int st_info, 147 uint64_t st_value, uint64_t st_size); 148 149 ssize_t load_elf_ram_sym(const char *filename, 150 uint64_t (*elf_note_fn)(void *, void *, bool), 151 uint64_t (*translate_fn)(void *, uint64_t), 152 void *translate_opaque, uint64_t *pentry, 153 uint64_t *lowaddr, uint64_t *highaddr, 154 uint32_t *pflags, int elf_data_order, int elf_machine, 155 int clear_lsb, int data_swab, 156 AddressSpace *as, bool load_rom, symbol_fn_t sym_cb); 157 158 /** load_elf_as: 159 * Same as load_elf_ram_sym(), but always loads the elf as ROM 160 */ 161 ssize_t load_elf_as(const char *filename, 162 uint64_t (*elf_note_fn)(void *, void *, bool), 163 uint64_t (*translate_fn)(void *, uint64_t), 164 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 165 uint64_t *highaddr, uint32_t *pflags, int elf_data_order, 166 int elf_machine, int clear_lsb, int data_swab, 167 AddressSpace *as); 168 169 /** load_elf: 170 * Same as load_elf_as(), but doesn't allow the caller to specify an 171 * AddressSpace. 172 */ 173 ssize_t load_elf(const char *filename, 174 uint64_t (*elf_note_fn)(void *, void *, bool), 175 uint64_t (*translate_fn)(void *, uint64_t), 176 void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr, 177 uint64_t *highaddr, uint32_t *pflags, int elf_data_order, 178 int elf_machine, int clear_lsb, int data_swab); 179 180 /** load_elf_hdr: 181 * @filename: Path of ELF file 182 * @hdr: Buffer to populate with header data. Header data will not be 183 * filled if set to NULL. 184 * @is64: Set to true if the ELF is 64bit. Ignored if set to NULL 185 * @errp: Populated with an error in failure cases 186 * 187 * Inspect an ELF file's header. Read its full header contents into a 188 * buffer and/or determine if the ELF is 64bit. 189 */ 190 void load_elf_hdr(const char *filename, void *hdr, bool *is64, Error **errp); 191 192 ssize_t load_aout(const char *filename, hwaddr addr, int max_sz, 193 int bswap_needed, hwaddr target_page_size); 194 195 #define LOAD_UIMAGE_LOADADDR_INVALID (-1) 196 197 /** load_uimage_as: 198 * @filename: Path of uimage file 199 * @ep: Populated with program entry point. Ignored if NULL. 200 * @loadaddr: load address if none specified in the image or when loading a 201 * ramdisk. Populated with the load address. Ignored if NULL or 202 * LOAD_UIMAGE_LOADADDR_INVALID (images which do not specify a load 203 * address will not be loadable). 204 * @is_linux: Is set to true if the image loaded is Linux. Ignored if NULL. 205 * @translate_fn: optional function to translate load addresses 206 * @translate_opaque: opaque data passed to @translate_fn 207 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 208 * is used if nothing is supplied here. 209 * 210 * Loads a u-boot image into memory. 211 * 212 * Returns the size of the loaded image on success, -1 otherwise. 213 */ 214 ssize_t load_uimage_as(const char *filename, hwaddr *ep, 215 hwaddr *loadaddr, int *is_linux, 216 uint64_t (*translate_fn)(void *, uint64_t), 217 void *translate_opaque, AddressSpace *as); 218 219 /** load_uimage: 220 * Same as load_uimage_as(), but doesn't allow the caller to specify an 221 * AddressSpace. 222 */ 223 ssize_t load_uimage(const char *filename, hwaddr *ep, 224 hwaddr *loadaddr, int *is_linux, 225 uint64_t (*translate_fn)(void *, uint64_t), 226 void *translate_opaque); 227 228 /** 229 * load_ramdisk_as: 230 * @filename: Path to the ramdisk image 231 * @addr: Memory address to load the ramdisk to 232 * @max_sz: Maximum allowed ramdisk size (for non-u-boot ramdisks) 233 * @as: The AddressSpace to load the ELF to. The value of address_space_memory 234 * is used if nothing is supplied here. 235 * 236 * Load a ramdisk image with U-Boot header to the specified memory 237 * address. 238 * 239 * Returns the size of the loaded image on success, -1 otherwise. 240 */ 241 ssize_t load_ramdisk_as(const char *filename, hwaddr addr, uint64_t max_sz, 242 AddressSpace *as); 243 244 /** 245 * load_ramdisk: 246 * Same as load_ramdisk_as(), but doesn't allow the caller to specify 247 * an AddressSpace. 248 */ 249 ssize_t load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz); 250 251 ssize_t gunzip(void *dst, size_t dstlen, uint8_t *src, size_t srclen); 252 253 ssize_t read_targphys(const char *name, 254 int fd, hwaddr dst_addr, size_t nbytes); 255 void pstrcpy_targphys(const char *name, 256 hwaddr dest, int buf_size, 257 const char *source); 258 259 ssize_t rom_add_file(const char *file, const char *fw_dir, 260 hwaddr addr, int32_t bootindex, 261 bool has_option_rom, MemoryRegion *mr, AddressSpace *as); 262 MemoryRegion *rom_add_blob(const char *name, const void *blob, size_t len, 263 size_t max_len, hwaddr addr, 264 const char *fw_file_name, 265 FWCfgCallback fw_callback, 266 void *callback_opaque, AddressSpace *as, 267 bool read_only); 268 int rom_add_elf_program(const char *name, GMappedFile *mapped_file, void *data, 269 size_t datasize, size_t romsize, hwaddr addr, 270 AddressSpace *as); 271 int rom_check_and_register_reset(void); 272 void rom_set_fw(FWCfgState *f); 273 void rom_set_order_override(int order); 274 void rom_reset_order_override(void); 275 276 /** 277 * rom_transaction_begin: 278 * 279 * Call this before of a series of rom_add_*() calls. Call 280 * rom_transaction_end() afterwards to commit or abort. These functions are 281 * useful for undoing a series of rom_add_*() calls if image file loading fails 282 * partway through. 283 */ 284 void rom_transaction_begin(void); 285 286 /** 287 * rom_transaction_end: 288 * @commit: true to commit added roms, false to drop added roms 289 * 290 * Call this after a series of rom_add_*() calls. See rom_transaction_begin(). 291 */ 292 void rom_transaction_end(bool commit); 293 294 int rom_copy(uint8_t *dest, hwaddr addr, size_t size); 295 void *rom_ptr(hwaddr addr, size_t size); 296 /** 297 * rom_ptr_for_as: Return a pointer to ROM blob data for the address 298 * @as: AddressSpace to look for the ROM blob in 299 * @addr: Address within @as 300 * @size: size of data required in bytes 301 * 302 * Returns: pointer into the data which backs the matching ROM blob, 303 * or NULL if no blob covers the address range. 304 * 305 * This function looks for a ROM blob which covers the specified range 306 * of bytes of length @size starting at @addr within the address space 307 * @as. This is useful for code which runs as part of board 308 * initialization or CPU reset which wants to read data that is part 309 * of a user-supplied guest image or other guest memory contents, but 310 * which runs before the ROM loader's reset function has copied the 311 * blobs into guest memory. 312 * 313 * rom_ptr_for_as() will look not just for blobs loaded directly to 314 * the specified address, but also for blobs which were loaded to an 315 * alias of the region at a different location in the AddressSpace. 316 * In other words, if a machine model has RAM at address 0x0000_0000 317 * which is aliased to also appear at 0x1000_0000, rom_ptr_for_as() 318 * will return the correct data whether the guest image was linked and 319 * loaded at 0x0000_0000 or 0x1000_0000. Contrast rom_ptr(), which 320 * will only return data if the image load address is an exact match 321 * with the queried address. 322 * 323 * New code should prefer to use rom_ptr_for_as() instead of 324 * rom_ptr(). 325 */ 326 void *rom_ptr_for_as(AddressSpace *as, hwaddr addr, size_t size); 327 328 #define rom_add_file_fixed(_f, _a, _i) \ 329 rom_add_file(_f, NULL, _a, _i, false, NULL, NULL) 330 #define rom_add_blob_fixed(_f, _b, _l, _a) \ 331 rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL, NULL, true) 332 #define rom_add_file_mr(_f, _mr, _i) \ 333 rom_add_file(_f, NULL, 0, _i, false, _mr, NULL) 334 #define rom_add_file_as(_f, _as, _i) \ 335 rom_add_file(_f, NULL, 0, _i, false, NULL, _as) 336 #define rom_add_file_fixed_as(_f, _a, _i, _as) \ 337 rom_add_file(_f, NULL, _a, _i, false, NULL, _as) 338 #define rom_add_blob_fixed_as(_f, _b, _l, _a, _as) \ 339 rom_add_blob(_f, _b, _l, _l, _a, NULL, NULL, NULL, _as, true) 340 341 ssize_t rom_add_vga(const char *file); 342 ssize_t rom_add_option(const char *file, int32_t bootindex); 343 344 /* This is the usual maximum in uboot, so if a uImage overflows this, it would 345 * overflow on real hardware too. */ 346 #define UBOOT_MAX_GUNZIP_BYTES (64 << 20) 347 348 typedef struct RomGap { 349 hwaddr base; 350 size_t size; 351 } RomGap; 352 353 /** 354 * rom_find_largest_gap_between: return largest gap between ROMs in given range 355 * 356 * Given a range of addresses, this function finds the largest 357 * contiguous subrange which has no ROMs loaded to it. That is, 358 * it finds the biggest gap which is free for use for other things. 359 */ 360 RomGap rom_find_largest_gap_between(hwaddr base, size_t size); 361 362 #endif 363