1/* 2 * ARM kernel loader. 3 * 4 * Copyright (c) 2006 CodeSourcery. 5 * Written by Paul Brook 6 * 7 * This code is licensed under the LGPL. 8 * 9 */ 10 11#ifndef HW_ARM_BOOT_H 12#define HW_ARM_BOOT_H 13 14#include "target/arm/cpu-qom.h" 15#include "qemu/notify.h" 16 17typedef enum { 18 ARM_ENDIANNESS_UNKNOWN = 0, 19 ARM_ENDIANNESS_LE, 20 ARM_ENDIANNESS_BE8, 21 ARM_ENDIANNESS_BE32, 22} arm_endianness; 23 24/** 25 * armv7m_load_kernel: 26 * @cpu: CPU 27 * @kernel_filename: file to load 28 * @mem_size: mem_size: maximum image size to load 29 * 30 * Load the guest image for an ARMv7M system. This must be called by 31 * any ARMv7M board. (This is necessary to ensure that the CPU resets 32 * correctly on system reset, as well as for kernel loading.) 33 */ 34void armv7m_load_kernel(ARMCPU *cpu, const char *kernel_filename, int mem_size); 35 36/* arm_boot.c */ 37struct arm_boot_info { 38 uint64_t ram_size; 39 const char *kernel_filename; 40 const char *kernel_cmdline; 41 const char *initrd_filename; 42 const char *dtb_filename; 43 hwaddr loader_start; 44 hwaddr dtb_start; 45 hwaddr dtb_limit; 46 /* If set to True, arm_load_kernel() will not load DTB. 47 * It allows board to load DTB manually later. 48 * (default: False) 49 */ 50 bool skip_dtb_autoload; 51 /* multicore boards that use the default secondary core boot functions 52 * need to put the address of the secondary boot code, the boot reg, 53 * and the GIC address in the next 3 values, respectively. boards that 54 * have their own boot functions can use these values as they want. 55 */ 56 hwaddr smp_loader_start; 57 hwaddr smp_bootreg_addr; 58 hwaddr gic_cpu_if_addr; 59 int nb_cpus; 60 int board_id; 61 /* ARM machines that support the ARM Security Extensions use this field to 62 * control whether Linux is booted as secure(true) or non-secure(false). 63 */ 64 bool secure_boot; 65 int (*atag_board)(const struct arm_boot_info *info, void *p); 66 /* multicore boards that use the default secondary core boot functions 67 * can ignore these two function calls. If the default functions won't 68 * work, then write_secondary_boot() should write a suitable blob of 69 * code mimicking the secondary CPU startup process used by the board's 70 * boot loader/boot ROM code, and secondary_cpu_reset_hook() should 71 * perform any necessary CPU reset handling and set the PC for the 72 * secondary CPUs to point at this boot blob. 73 */ 74 void (*write_secondary_boot)(ARMCPU *cpu, 75 const struct arm_boot_info *info); 76 void (*secondary_cpu_reset_hook)(ARMCPU *cpu, 77 const struct arm_boot_info *info); 78 /* if a board is able to create a dtb without a dtb file then it 79 * sets get_dtb. This will only be used if no dtb file is provided 80 * by the user. On success, sets *size to the length of the created 81 * dtb, and returns a pointer to it. (The caller must free this memory 82 * with g_free() when it has finished with it.) On failure, returns NULL. 83 */ 84 void *(*get_dtb)(const struct arm_boot_info *info, int *size); 85 /* if a board needs to be able to modify a device tree provided by 86 * the user it should implement this hook. 87 */ 88 void (*modify_dtb)(const struct arm_boot_info *info, void *fdt); 89 /* Used internally by arm_boot.c */ 90 int is_linux; 91 hwaddr initrd_start; 92 hwaddr initrd_size; 93 hwaddr entry; 94 95 /* Boot firmware has been loaded, typically at address 0, with -bios or 96 * -pflash. It also implies that fw_cfg_find() will succeed. 97 */ 98 bool firmware_loaded; 99 100 /* Address at which board specific loader/setup code exists. If enabled, 101 * this code-blob will run before anything else. It must return to the 102 * caller via the link register. There is no stack set up. Enabled by 103 * defining write_board_setup, which is responsible for loading the blob 104 * to the specified address. 105 */ 106 hwaddr board_setup_addr; 107 void (*write_board_setup)(ARMCPU *cpu, 108 const struct arm_boot_info *info); 109 110 /* 111 * If set, the board specific loader/setup blob will be run from secure 112 * mode, regardless of secure_boot. The blob becomes responsible for 113 * changing to non-secure state if implementing a non-secure boot, 114 * including setting up EL3/Secure registers such as the NSACR as 115 * required by the Linux booting ABI before the switch to non-secure. 116 */ 117 bool secure_board_setup; 118 119 arm_endianness endianness; 120}; 121 122/** 123 * arm_load_kernel - Loads memory with everything needed to boot 124 * 125 * @cpu: handle to the first CPU object 126 * @info: handle to the boot info struct 127 * Registers a machine init done notifier that copies to memory 128 * everything needed to boot, depending on machine and user options: 129 * kernel image, boot loaders, initrd, dtb. Also registers the CPU 130 * reset handler. 131 * 132 * In case the machine file supports the platform bus device and its 133 * dynamically instantiable sysbus devices, this function must be called 134 * before sysbus-fdt arm_register_platform_bus_fdt_creator. Indeed the 135 * machine init done notifiers are called in registration reverse order. 136 */ 137void arm_load_kernel(ARMCPU *cpu, MachineState *ms, struct arm_boot_info *info); 138 139AddressSpace *arm_boot_address_space(ARMCPU *cpu, 140 const struct arm_boot_info *info); 141 142/** 143 * arm_load_dtb() - load a device tree binary image into memory 144 * @addr: the address to load the image at 145 * @binfo: struct describing the boot environment 146 * @addr_limit: upper limit of the available memory area at @addr 147 * @as: address space to load image to 148 * 149 * Load a device tree supplied by the machine or by the user with the 150 * '-dtb' command line option, and put it at offset @addr in target 151 * memory. 152 * 153 * If @addr_limit contains a meaningful value (i.e., it is strictly greater 154 * than @addr), the device tree is only loaded if its size does not exceed 155 * the limit. 156 * 157 * Returns: the size of the device tree image on success, 158 * 0 if the image size exceeds the limit, 159 * -1 on errors. 160 * 161 * Note: Must not be called unless have_dtb(binfo) is true. 162 */ 163int arm_load_dtb(hwaddr addr, const struct arm_boot_info *binfo, 164 hwaddr addr_limit, AddressSpace *as, MachineState *ms); 165 166/* Write a secure board setup routine with a dummy handler for SMCs */ 167void arm_write_secure_board_setup_dummy_smc(ARMCPU *cpu, 168 const struct arm_boot_info *info, 169 hwaddr mvbar_addr); 170 171#endif /* HW_ARM_BOOT_H */ 172