xref: /qemu/include/hw/riscv/boot.h (revision 60a07d4a6e65f51916a417adb5e56b3f7b38ed22)
10ac24d56SAlistair Francis /*
20ac24d56SAlistair Francis  * QEMU RISC-V Boot Helper
30ac24d56SAlistair Francis  *
40ac24d56SAlistair Francis  * Copyright (c) 2017 SiFive, Inc.
50ac24d56SAlistair Francis  * Copyright (c) 2019 Alistair Francis <alistair.francis@wdc.com>
60ac24d56SAlistair Francis  *
70ac24d56SAlistair Francis  * This program is free software; you can redistribute it and/or modify it
80ac24d56SAlistair Francis  * under the terms and conditions of the GNU General Public License,
90ac24d56SAlistair Francis  * version 2 or later, as published by the Free Software Foundation.
100ac24d56SAlistair Francis  *
110ac24d56SAlistair Francis  * This program is distributed in the hope it will be useful, but WITHOUT
120ac24d56SAlistair Francis  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
130ac24d56SAlistair Francis  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
140ac24d56SAlistair Francis  * more details.
150ac24d56SAlistair Francis  *
160ac24d56SAlistair Francis  * You should have received a copy of the GNU General Public License along with
170ac24d56SAlistair Francis  * this program.  If not, see <http://www.gnu.org/licenses/>.
180ac24d56SAlistair Francis  */
190ac24d56SAlistair Francis 
200ac24d56SAlistair Francis #ifndef RISCV_BOOT_H
210ac24d56SAlistair Francis #define RISCV_BOOT_H
220ac24d56SAlistair Francis 
23ec150c7eSMarkus Armbruster #include "exec/cpu-defs.h"
24757e99b1SAlistair Francis #include "hw/loader.h"
253ed2b8acSAlistair Francis #include "hw/riscv/riscv_hart.h"
26ec150c7eSMarkus Armbruster 
27a0acd0a1SBin Meng #define RISCV32_BIOS_BIN    "opensbi-riscv32-generic-fw_dynamic.bin"
28a0acd0a1SBin Meng #define RISCV64_BIOS_BIN    "opensbi-riscv64-generic-fw_dynamic.bin"
29a0acd0a1SBin Meng 
30d3592955SJim Shu typedef struct RISCVBootInfo {
31d3592955SJim Shu     ssize_t kernel_size;
32d3592955SJim Shu     hwaddr image_low_addr;
33d3592955SJim Shu     hwaddr image_high_addr;
34d3592955SJim Shu 
35*1a65064cSJim Shu     hwaddr initrd_start;
36*1a65064cSJim Shu     ssize_t initrd_size;
37*1a65064cSJim Shu 
38d3592955SJim Shu     bool is_32bit;
39d3592955SJim Shu } RISCVBootInfo;
40d3592955SJim Shu 
41a8259b53SAlistair Francis bool riscv_is_32bit(RISCVHartArrayState *harts);
42c4077842SAlistair Francis 
43bf357e1dSAlistair Francis char *riscv_plic_hart_config_string(int hart_count);
44bf357e1dSAlistair Francis 
45d3592955SJim Shu void riscv_boot_info_init(RISCVBootInfo *info, RISCVHartArrayState *harts);
46d3592955SJim Shu target_ulong riscv_calc_kernel_start_addr(RISCVBootInfo *info,
4738bc4e34SAlistair Francis                                           target_ulong firmware_end_addr);
48e66c531eSAlistair Francis target_ulong riscv_find_and_load_firmware(MachineState *machine,
49fdd1bda4SAlistair Francis                                           const char *default_machine_firmware,
5055c13659SSamuel Holland                                           hwaddr *firmware_load_addr,
5102777ac3SAnup Patel                                           symbol_fn_t sym_cb);
529d3f7108SDaniel Henrique Barboza const char *riscv_default_firmware_name(RISCVHartArrayState *harts);
538f619626SBin Meng char *riscv_find_firmware(const char *firmware_filename,
548f619626SBin Meng                           const char *default_machine_firmware);
55b3042223SAlistair Francis target_ulong riscv_load_firmware(const char *firmware_filename,
5655c13659SSamuel Holland                                  hwaddr *firmware_load_addr,
5702777ac3SAnup Patel                                  symbol_fn_t sym_cb);
58d3592955SJim Shu void riscv_load_kernel(MachineState *machine,
59d3592955SJim Shu                        RISCVBootInfo *info,
60d3592955SJim Shu                        target_ulong kernel_start_addr,
61487d73fcSDaniel Henrique Barboza                        bool load_initrd,
626478dd74SZhuang, Siwei (Data61, Kensington NSW)                        symbol_fn_t sym_cb);
63d3592955SJim Shu uint64_t riscv_compute_fdt_addr(hwaddr dram_base, hwaddr dram_size,
64d3592955SJim Shu                                 MachineState *ms, RISCVBootInfo *info);
65bc2c0153SDaniel Henrique Barboza void riscv_load_fdt(hwaddr fdt_addr, void *fdt);
66a8259b53SAlistair Francis void riscv_setup_rom_reset_vec(MachineState *machine, RISCVHartArrayState *harts,
673ed2b8acSAlistair Francis                                hwaddr saddr,
6878936771SAlistair Francis                                hwaddr rom_base, hwaddr rom_size,
6978936771SAlistair Francis                                uint64_t kernel_entry,
706934f15bSDaniel Henrique Barboza                                uint64_t fdt_load_addr);
7165838488STANG Tiancheng void riscv_rom_copy_firmware_info(MachineState *machine,
7265838488STANG Tiancheng                                   RISCVHartArrayState *harts,
7365838488STANG Tiancheng                                   hwaddr rom_base,
7478936771SAlistair Francis                                   hwaddr rom_size,
75dc144fe1SAtish Patra                                   uint32_t reset_vec_size,
76dc144fe1SAtish Patra                                   uint64_t kernel_entry);
77ad40be27SYifei Jiang void riscv_setup_direct_kernel(hwaddr kernel_addr, hwaddr fdt_addr);
78a5b0249dSSunil V L void riscv_setup_firmware_boot(MachineState *machine);
790ac24d56SAlistair Francis 
800ac24d56SAlistair Francis #endif /* RISCV_BOOT_H */
81