xref: /openbmc/qemu/include/hw/loader.h (revision 776ec96f)
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  */
14 int get_image_size(const char *filename);
15 int load_image(const char *filename, uint8_t *addr); /* deprecated */
16 ssize_t load_image_size(const char *filename, void *addr, size_t size);
17 int load_image_targphys(const char *filename, hwaddr,
18                         uint64_t max_sz);
19 int load_image_gzipped(const char *filename, hwaddr addr, uint64_t max_sz);
20 
21 #define ELF_LOAD_FAILED       -1
22 #define ELF_LOAD_NOT_ELF      -2
23 #define ELF_LOAD_WRONG_ARCH   -3
24 #define ELF_LOAD_WRONG_ENDIAN -4
25 const char *load_elf_strerror(int error);
26 int load_elf(const char *filename, uint64_t (*translate_fn)(void *, uint64_t),
27              void *translate_opaque, uint64_t *pentry, uint64_t *lowaddr,
28              uint64_t *highaddr, int big_endian, int elf_machine,
29              int clear_lsb);
30 int load_aout(const char *filename, hwaddr addr, int max_sz,
31               int bswap_needed, hwaddr target_page_size);
32 int load_uimage(const char *filename, hwaddr *ep,
33                 hwaddr *loadaddr, int *is_linux,
34                 uint64_t (*translate_fn)(void *, uint64_t),
35                 void *translate_opaque);
36 
37 /**
38  * load_ramdisk:
39  * @filename: Path to the ramdisk image
40  * @addr: Memory address to load the ramdisk to
41  * @max_sz: Maximum allowed ramdisk size (for non-u-boot ramdisks)
42  *
43  * Load a ramdisk image with U-Boot header to the specified memory
44  * address.
45  *
46  * Returns the size of the loaded image on success, -1 otherwise.
47  */
48 int load_ramdisk(const char *filename, hwaddr addr, uint64_t max_sz);
49 
50 ssize_t read_targphys(const char *name,
51                       int fd, hwaddr dst_addr, size_t nbytes);
52 void pstrcpy_targphys(const char *name,
53                       hwaddr dest, int buf_size,
54                       const char *source);
55 
56 extern bool option_rom_has_mr;
57 extern bool rom_file_has_mr;
58 
59 int rom_add_file(const char *file, const char *fw_dir,
60                  hwaddr addr, int32_t bootindex,
61                  bool option_rom);
62 void *rom_add_blob(const char *name, const void *blob, size_t len,
63                    hwaddr addr, const char *fw_file_name,
64                    FWCfgReadCallback fw_callback, void *callback_opaque);
65 int rom_add_elf_program(const char *name, void *data, size_t datasize,
66                         size_t romsize, hwaddr addr);
67 int rom_load_all(void);
68 void rom_load_done(void);
69 void rom_set_fw(FWCfgState *f);
70 int rom_copy(uint8_t *dest, hwaddr addr, size_t size);
71 void *rom_ptr(hwaddr addr);
72 void do_info_roms(Monitor *mon, const QDict *qdict);
73 
74 #define rom_add_file_fixed(_f, _a, _i)          \
75     rom_add_file(_f, NULL, _a, _i, false)
76 #define rom_add_blob_fixed(_f, _b, _l, _a)      \
77     rom_add_blob(_f, _b, _l, _a, NULL, NULL, NULL)
78 
79 #define PC_ROM_MIN_VGA     0xc0000
80 #define PC_ROM_MIN_OPTION  0xc8000
81 #define PC_ROM_MAX         0xe0000
82 #define PC_ROM_ALIGN       0x800
83 #define PC_ROM_SIZE        (PC_ROM_MAX - PC_ROM_MIN_VGA)
84 
85 int rom_add_vga(const char *file);
86 int rom_add_option(const char *file, int32_t bootindex);
87 
88 #endif
89