1e481a1f6SAlistair Francis /* 2e481a1f6SAlistair Francis * Generic Loader 3e481a1f6SAlistair Francis * 4e481a1f6SAlistair Francis * Copyright (C) 2014 Li Guang 5e481a1f6SAlistair Francis * Copyright (C) 2016 Xilinx Inc. 6e481a1f6SAlistair Francis * Written by Li Guang <lig.fnst@cn.fujitsu.com> 7e481a1f6SAlistair Francis * 8e481a1f6SAlistair Francis * This program is free software; you can redistribute it and/or modify it 9e481a1f6SAlistair Francis * under the terms of the GNU General Public License as published by the 10e481a1f6SAlistair Francis * Free Software Foundation; either version 2 of the License, or 11e481a1f6SAlistair Francis * (at your option) any later version. 12e481a1f6SAlistair Francis * 13e481a1f6SAlistair Francis * This program is distributed in the hope that it will be useful, but WITHOUT 14e481a1f6SAlistair Francis * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 15e481a1f6SAlistair Francis * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 16e481a1f6SAlistair Francis * for more details. 17e481a1f6SAlistair Francis * 18e481a1f6SAlistair Francis */ 19e481a1f6SAlistair Francis 20e481a1f6SAlistair Francis /* 21e481a1f6SAlistair Francis * Internally inside QEMU this is a device. It is a strange device that 22e481a1f6SAlistair Francis * provides no hardware interface but allows QEMU to monkey patch memory 23e481a1f6SAlistair Francis * specified when it is created. To be able to do this it has a reset 24e481a1f6SAlistair Francis * callback that does the memory operations. 25e481a1f6SAlistair Francis 26e481a1f6SAlistair Francis * This device allows the user to monkey patch memory. To be able to do 27e481a1f6SAlistair Francis * this it needs a backend to manage the datas, the same as other 28e481a1f6SAlistair Francis * memory-related devices. In this case as the backend is so trivial we 29e481a1f6SAlistair Francis * have merged it with the frontend instead of creating and maintaining a 30b12227afSStefan Weil * separate backend. 31e481a1f6SAlistair Francis */ 32e481a1f6SAlistair Francis 33e481a1f6SAlistair Francis #include "qemu/osdep.h" 34e481a1f6SAlistair Francis #include "qom/cpu.h" 35e481a1f6SAlistair Francis #include "hw/sysbus.h" 36e481a1f6SAlistair Francis #include "sysemu/dma.h" 37e481a1f6SAlistair Francis #include "hw/loader.h" 38e481a1f6SAlistair Francis #include "qapi/error.h" 39e481a1f6SAlistair Francis #include "hw/core/generic-loader.h" 40e481a1f6SAlistair Francis 41e481a1f6SAlistair Francis #define CPU_NONE 0xFFFFFFFF 42e481a1f6SAlistair Francis 43e481a1f6SAlistair Francis static void generic_loader_reset(void *opaque) 44e481a1f6SAlistair Francis { 45e481a1f6SAlistair Francis GenericLoaderState *s = GENERIC_LOADER(opaque); 46e481a1f6SAlistair Francis 47e481a1f6SAlistair Francis if (s->set_pc) { 48e481a1f6SAlistair Francis CPUClass *cc = CPU_GET_CLASS(s->cpu); 49e481a1f6SAlistair Francis cpu_reset(s->cpu); 50e481a1f6SAlistair Francis if (cc) { 51e481a1f6SAlistair Francis cc->set_pc(s->cpu, s->addr); 52e481a1f6SAlistair Francis } 53e481a1f6SAlistair Francis } 54e481a1f6SAlistair Francis 55e481a1f6SAlistair Francis if (s->data_len) { 56e481a1f6SAlistair Francis assert(s->data_len < sizeof(s->data)); 57e481a1f6SAlistair Francis dma_memory_write(s->cpu->as, s->addr, &s->data, s->data_len); 58e481a1f6SAlistair Francis } 59e481a1f6SAlistair Francis } 60e481a1f6SAlistair Francis 61e481a1f6SAlistair Francis static void generic_loader_realize(DeviceState *dev, Error **errp) 62e481a1f6SAlistair Francis { 63e481a1f6SAlistair Francis GenericLoaderState *s = GENERIC_LOADER(dev); 64e481a1f6SAlistair Francis hwaddr entry; 65e481a1f6SAlistair Francis int big_endian; 66e481a1f6SAlistair Francis int size = 0; 67e481a1f6SAlistair Francis 68e481a1f6SAlistair Francis s->set_pc = false; 69e481a1f6SAlistair Francis 70e481a1f6SAlistair Francis /* Perform some error checking on the user's options */ 71e481a1f6SAlistair Francis if (s->data || s->data_len || s->data_be) { 72e481a1f6SAlistair Francis /* User is loading memory values */ 73e481a1f6SAlistair Francis if (s->file) { 74e481a1f6SAlistair Francis error_setg(errp, "Specifying a file is not supported when loading " 75e481a1f6SAlistair Francis "memory values"); 76e481a1f6SAlistair Francis return; 77e481a1f6SAlistair Francis } else if (s->force_raw) { 78e481a1f6SAlistair Francis error_setg(errp, "Specifying force-raw is not supported when " 79e481a1f6SAlistair Francis "loading memory values"); 80e481a1f6SAlistair Francis return; 81e481a1f6SAlistair Francis } else if (!s->data_len) { 82b12227afSStefan Weil /* We can't check for !data here as a value of 0 is still valid. */ 83e481a1f6SAlistair Francis error_setg(errp, "Both data and data-len must be specified"); 84e481a1f6SAlistair Francis return; 85e481a1f6SAlistair Francis } else if (s->data_len > 8) { 86e481a1f6SAlistair Francis error_setg(errp, "data-len cannot be greater then 8 bytes"); 87e481a1f6SAlistair Francis return; 88e481a1f6SAlistair Francis } 89e481a1f6SAlistair Francis } else if (s->file || s->force_raw) { 90e481a1f6SAlistair Francis /* User is loading an image */ 91e481a1f6SAlistair Francis if (s->data || s->data_len || s->data_be) { 92e481a1f6SAlistair Francis error_setg(errp, "data can not be specified when loading an " 93e481a1f6SAlistair Francis "image"); 94e481a1f6SAlistair Francis return; 95e481a1f6SAlistair Francis } 966aa3a616SAlistair Francis /* The user specified a file, only set the PC if they also specified 976aa3a616SAlistair Francis * a CPU to use. 986aa3a616SAlistair Francis */ 996aa3a616SAlistair Francis if (s->cpu_num != CPU_NONE) { 100e481a1f6SAlistair Francis s->set_pc = true; 1016aa3a616SAlistair Francis } 102e481a1f6SAlistair Francis } else if (s->addr) { 103e481a1f6SAlistair Francis /* User is setting the PC */ 104e481a1f6SAlistair Francis if (s->data || s->data_len || s->data_be) { 105e481a1f6SAlistair Francis error_setg(errp, "data can not be specified when setting a " 106e481a1f6SAlistair Francis "program counter"); 107e481a1f6SAlistair Francis return; 108bbba7757SPeter Maydell } else if (s->cpu_num == CPU_NONE) { 109e481a1f6SAlistair Francis error_setg(errp, "cpu_num must be specified when setting a " 110e481a1f6SAlistair Francis "program counter"); 111e481a1f6SAlistair Francis return; 112e481a1f6SAlistair Francis } 113e481a1f6SAlistair Francis s->set_pc = true; 114e481a1f6SAlistair Francis } else { 115e481a1f6SAlistair Francis /* Did the user specify anything? */ 116e481a1f6SAlistair Francis error_setg(errp, "please include valid arguments"); 117e481a1f6SAlistair Francis return; 118e481a1f6SAlistair Francis } 119e481a1f6SAlistair Francis 120e481a1f6SAlistair Francis qemu_register_reset(generic_loader_reset, dev); 121e481a1f6SAlistair Francis 122e481a1f6SAlistair Francis if (s->cpu_num != CPU_NONE) { 123e481a1f6SAlistair Francis s->cpu = qemu_get_cpu(s->cpu_num); 124e481a1f6SAlistair Francis if (!s->cpu) { 125e481a1f6SAlistair Francis error_setg(errp, "Specified boot CPU#%d is nonexistent", 126e481a1f6SAlistair Francis s->cpu_num); 127e481a1f6SAlistair Francis return; 128e481a1f6SAlistair Francis } 129e481a1f6SAlistair Francis } else { 130e481a1f6SAlistair Francis s->cpu = first_cpu; 131e481a1f6SAlistair Francis } 132e481a1f6SAlistair Francis 1331a1ff38cSThomas Huth big_endian = target_words_bigendian(); 134e481a1f6SAlistair Francis 135e481a1f6SAlistair Francis if (s->file) { 1366516367fSThomas Huth AddressSpace *as = s->cpu ? s->cpu->as : NULL; 1376516367fSThomas Huth 138e481a1f6SAlistair Francis if (!s->force_raw) { 139*4366e1dbSLiam Merwick size = load_elf_as(s->file, NULL, NULL, NULL, &entry, NULL, NULL, 1406516367fSThomas Huth big_endian, 0, 0, 0, as); 141e481a1f6SAlistair Francis 142e481a1f6SAlistair Francis if (size < 0) { 143e481a1f6SAlistair Francis size = load_uimage_as(s->file, &entry, NULL, NULL, NULL, NULL, 1446516367fSThomas Huth as); 145e481a1f6SAlistair Francis } 146e4a25ed9SSu Hang 147e4a25ed9SSu Hang if (size < 0) { 148e4a25ed9SSu Hang size = load_targphys_hex_as(s->file, &entry, as); 149e4a25ed9SSu Hang } 150e481a1f6SAlistair Francis } 151e481a1f6SAlistair Francis 152e481a1f6SAlistair Francis if (size < 0 || s->force_raw) { 153e481a1f6SAlistair Francis /* Default to the maximum size being the machine's ram size */ 1546516367fSThomas Huth size = load_image_targphys_as(s->file, s->addr, ram_size, as); 155e481a1f6SAlistair Francis } else { 156e481a1f6SAlistair Francis s->addr = entry; 157e481a1f6SAlistair Francis } 158e481a1f6SAlistair Francis 159e481a1f6SAlistair Francis if (size < 0) { 160e481a1f6SAlistair Francis error_setg(errp, "Cannot load specified image %s", s->file); 161e481a1f6SAlistair Francis return; 162e481a1f6SAlistair Francis } 163e481a1f6SAlistair Francis } 164e481a1f6SAlistair Francis 165e481a1f6SAlistair Francis /* Convert the data endiannes */ 166e481a1f6SAlistair Francis if (s->data_be) { 167e481a1f6SAlistair Francis s->data = cpu_to_be64(s->data); 168e481a1f6SAlistair Francis } else { 169e481a1f6SAlistair Francis s->data = cpu_to_le64(s->data); 170e481a1f6SAlistair Francis } 171e481a1f6SAlistair Francis } 172e481a1f6SAlistair Francis 173e481a1f6SAlistair Francis static void generic_loader_unrealize(DeviceState *dev, Error **errp) 174e481a1f6SAlistair Francis { 175e481a1f6SAlistair Francis qemu_unregister_reset(generic_loader_reset, dev); 176e481a1f6SAlistair Francis } 177e481a1f6SAlistair Francis 178e481a1f6SAlistair Francis static Property generic_loader_props[] = { 179e481a1f6SAlistair Francis DEFINE_PROP_UINT64("addr", GenericLoaderState, addr, 0), 180e481a1f6SAlistair Francis DEFINE_PROP_UINT64("data", GenericLoaderState, data, 0), 181e481a1f6SAlistair Francis DEFINE_PROP_UINT8("data-len", GenericLoaderState, data_len, 0), 182e481a1f6SAlistair Francis DEFINE_PROP_BOOL("data-be", GenericLoaderState, data_be, false), 183e481a1f6SAlistair Francis DEFINE_PROP_UINT32("cpu-num", GenericLoaderState, cpu_num, CPU_NONE), 184e481a1f6SAlistair Francis DEFINE_PROP_BOOL("force-raw", GenericLoaderState, force_raw, false), 185e481a1f6SAlistair Francis DEFINE_PROP_STRING("file", GenericLoaderState, file), 186e481a1f6SAlistair Francis DEFINE_PROP_END_OF_LIST(), 187e481a1f6SAlistair Francis }; 188e481a1f6SAlistair Francis 189e481a1f6SAlistair Francis static void generic_loader_class_init(ObjectClass *klass, void *data) 190e481a1f6SAlistair Francis { 191e481a1f6SAlistair Francis DeviceClass *dc = DEVICE_CLASS(klass); 192e481a1f6SAlistair Francis 193e481a1f6SAlistair Francis /* The reset function is not registered here and is instead registered in 194e481a1f6SAlistair Francis * the realize function to allow this device to be added via the device_add 195e481a1f6SAlistair Francis * command in the QEMU monitor. 196e481a1f6SAlistair Francis * TODO: Improve the device_add functionality to allow resets to be 197e481a1f6SAlistair Francis * connected 198e481a1f6SAlistair Francis */ 199e481a1f6SAlistair Francis dc->realize = generic_loader_realize; 200e481a1f6SAlistair Francis dc->unrealize = generic_loader_unrealize; 201e481a1f6SAlistair Francis dc->props = generic_loader_props; 202e481a1f6SAlistair Francis dc->desc = "Generic Loader"; 2038c827c53SThomas Huth set_bit(DEVICE_CATEGORY_MISC, dc->categories); 204e481a1f6SAlistair Francis } 205e481a1f6SAlistair Francis 206e481a1f6SAlistair Francis static TypeInfo generic_loader_info = { 207e481a1f6SAlistair Francis .name = TYPE_GENERIC_LOADER, 208e481a1f6SAlistair Francis .parent = TYPE_DEVICE, 209e481a1f6SAlistair Francis .instance_size = sizeof(GenericLoaderState), 210e481a1f6SAlistair Francis .class_init = generic_loader_class_init, 211e481a1f6SAlistair Francis }; 212e481a1f6SAlistair Francis 213e481a1f6SAlistair Francis static void generic_loader_register_type(void) 214e481a1f6SAlistair Francis { 215e481a1f6SAlistair Francis type_register_static(&generic_loader_info); 216e481a1f6SAlistair Francis } 217e481a1f6SAlistair Francis 218e481a1f6SAlistair Francis type_init(generic_loader_register_type) 219