hw/arm/raspi: Use RaspiProcessorId to set the firmware load address
[qemu.git] / hw / arm / raspi.c
1 /*
2 * Raspberry Pi emulation (c) 2012 Gregory Estrade
3 * Upstreaming code cleanup [including bcm2835_*] (c) 2013 Jan Petrous
4 *
5 * Rasperry Pi 2 emulation Copyright (c) 2015, Microsoft
6 * Written by Andrew Baumann
7 *
8 * Raspberry Pi 3 emulation Copyright (c) 2018 Zoltán Baldaszti
9 * Upstream code cleanup (c) 2018 Pekka Enberg
10 *
11 * This work is licensed under the terms of the GNU GPL, version 2 or later.
12 * See the COPYING file in the top-level directory.
13 */
14
15 #include "qemu/osdep.h"
16 #include "qemu/units.h"
17 #include "qemu/cutils.h"
18 #include "qapi/error.h"
19 #include "cpu.h"
20 #include "hw/arm/bcm2836.h"
21 #include "hw/registerfields.h"
22 #include "qemu/error-report.h"
23 #include "hw/boards.h"
24 #include "hw/loader.h"
25 #include "hw/arm/boot.h"
26 #include "sysemu/sysemu.h"
27 #include "qom/object.h"
28
29 #define SMPBOOT_ADDR 0x300 /* this should leave enough space for ATAGS */
30 #define MVBAR_ADDR 0x400 /* secure vectors */
31 #define BOARDSETUP_ADDR (MVBAR_ADDR + 0x20) /* board setup code */
32 #define FIRMWARE_ADDR_2 0x8000 /* Pi 2 loads kernel.img here by default */
33 #define FIRMWARE_ADDR_3 0x80000 /* Pi 3 loads kernel.img here by default */
34 #define SPINTABLE_ADDR 0xd8 /* Pi 3 bootloader spintable */
35
36 /* Registered machine type (matches RPi Foundation bootloader and U-Boot) */
37 #define MACH_TYPE_BCM2708 3138
38
39 struct RaspiMachineState {
40 /*< private >*/
41 MachineState parent_obj;
42 /*< public >*/
43 BCM283XState soc;
44 struct arm_boot_info binfo;
45 };
46 typedef struct RaspiMachineState RaspiMachineState;
47
48 struct RaspiMachineClass {
49 /*< private >*/
50 MachineClass parent_obj;
51 /*< public >*/
52 uint32_t board_rev;
53 };
54 typedef struct RaspiMachineClass RaspiMachineClass;
55
56 #define TYPE_RASPI_MACHINE MACHINE_TYPE_NAME("raspi-common")
57 DECLARE_OBJ_CHECKERS(RaspiMachineState, RaspiMachineClass,
58 RASPI_MACHINE, TYPE_RASPI_MACHINE)
59
60
61 /*
62 * Board revision codes:
63 * www.raspberrypi.org/documentation/hardware/raspberrypi/revision-codes/
64 */
65 FIELD(REV_CODE, REVISION, 0, 4);
66 FIELD(REV_CODE, TYPE, 4, 8);
67 FIELD(REV_CODE, PROCESSOR, 12, 4);
68 FIELD(REV_CODE, MANUFACTURER, 16, 4);
69 FIELD(REV_CODE, MEMORY_SIZE, 20, 3);
70 FIELD(REV_CODE, STYLE, 23, 1);
71
72 typedef enum RaspiProcessorId {
73 PROCESSOR_ID_BCM2836 = 1,
74 PROCESSOR_ID_BCM2837 = 2,
75 } RaspiProcessorId;
76
77 static const struct {
78 const char *type;
79 int cores_count;
80 } soc_property[] = {
81 [PROCESSOR_ID_BCM2836] = {TYPE_BCM2836, BCM283X_NCPUS},
82 [PROCESSOR_ID_BCM2837] = {TYPE_BCM2837, BCM283X_NCPUS},
83 };
84
85 static uint64_t board_ram_size(uint32_t board_rev)
86 {
87 assert(FIELD_EX32(board_rev, REV_CODE, STYLE)); /* Only new style */
88 return 256 * MiB << FIELD_EX32(board_rev, REV_CODE, MEMORY_SIZE);
89 }
90
91 static RaspiProcessorId board_processor_id(uint32_t board_rev)
92 {
93 int proc_id = FIELD_EX32(board_rev, REV_CODE, PROCESSOR);
94
95 assert(FIELD_EX32(board_rev, REV_CODE, STYLE)); /* Only new style */
96 assert(proc_id < ARRAY_SIZE(soc_property) && soc_property[proc_id].type);
97
98 return proc_id;
99 }
100
101 static int board_version(uint32_t board_rev)
102 {
103 return board_processor_id(board_rev) + 1;
104 }
105
106 static const char *board_soc_type(uint32_t board_rev)
107 {
108 return soc_property[board_processor_id(board_rev)].type;
109 }
110
111 static int cores_count(uint32_t board_rev)
112 {
113 return soc_property[board_processor_id(board_rev)].cores_count;
114 }
115
116 static const char *board_type(uint32_t board_rev)
117 {
118 static const char *types[] = {
119 "A", "B", "A+", "B+", "2B", "Alpha", "CM1", NULL, "3B", "Zero",
120 "CM3", NULL, "Zero W", "3B+", "3A+", NULL, "CM3+", "4B",
121 };
122 assert(FIELD_EX32(board_rev, REV_CODE, STYLE)); /* Only new style */
123 int bt = FIELD_EX32(board_rev, REV_CODE, TYPE);
124 if (bt >= ARRAY_SIZE(types) || !types[bt]) {
125 return "Unknown";
126 }
127 return types[bt];
128 }
129
130 static void write_smpboot(ARMCPU *cpu, const struct arm_boot_info *info)
131 {
132 static const uint32_t smpboot[] = {
133 0xe1a0e00f, /* mov lr, pc */
134 0xe3a0fe00 + (BOARDSETUP_ADDR >> 4), /* mov pc, BOARDSETUP_ADDR */
135 0xee100fb0, /* mrc p15, 0, r0, c0, c0, 5;get core ID */
136 0xe7e10050, /* ubfx r0, r0, #0, #2 ;extract LSB */
137 0xe59f5014, /* ldr r5, =0x400000CC ;load mbox base */
138 0xe320f001, /* 1: yield */
139 0xe7953200, /* ldr r3, [r5, r0, lsl #4] ;read mbox for our core*/
140 0xe3530000, /* cmp r3, #0 ;spin while zero */
141 0x0afffffb, /* beq 1b */
142 0xe7853200, /* str r3, [r5, r0, lsl #4] ;clear mbox */
143 0xe12fff13, /* bx r3 ;jump to target */
144 0x400000cc, /* (constant: mailbox 3 read/clear base) */
145 };
146
147 /* check that we don't overrun board setup vectors */
148 QEMU_BUILD_BUG_ON(SMPBOOT_ADDR + sizeof(smpboot) > MVBAR_ADDR);
149 /* check that board setup address is correctly relocated */
150 QEMU_BUILD_BUG_ON((BOARDSETUP_ADDR & 0xf) != 0
151 || (BOARDSETUP_ADDR >> 4) >= 0x100);
152
153 rom_add_blob_fixed_as("raspi_smpboot", smpboot, sizeof(smpboot),
154 info->smp_loader_start,
155 arm_boot_address_space(cpu, info));
156 }
157
158 static void write_smpboot64(ARMCPU *cpu, const struct arm_boot_info *info)
159 {
160 AddressSpace *as = arm_boot_address_space(cpu, info);
161 /* Unlike the AArch32 version we don't need to call the board setup hook.
162 * The mechanism for doing the spin-table is also entirely different.
163 * We must have four 64-bit fields at absolute addresses
164 * 0xd8, 0xe0, 0xe8, 0xf0 in RAM, which are the flag variables for
165 * our CPUs, and which we must ensure are zero initialized before
166 * the primary CPU goes into the kernel. We put these variables inside
167 * a rom blob, so that the reset for ROM contents zeroes them for us.
168 */
169 static const uint32_t smpboot[] = {
170 0xd2801b05, /* mov x5, 0xd8 */
171 0xd53800a6, /* mrs x6, mpidr_el1 */
172 0x924004c6, /* and x6, x6, #0x3 */
173 0xd503205f, /* spin: wfe */
174 0xf86678a4, /* ldr x4, [x5,x6,lsl #3] */
175 0xb4ffffc4, /* cbz x4, spin */
176 0xd2800000, /* mov x0, #0x0 */
177 0xd2800001, /* mov x1, #0x0 */
178 0xd2800002, /* mov x2, #0x0 */
179 0xd2800003, /* mov x3, #0x0 */
180 0xd61f0080, /* br x4 */
181 };
182
183 static const uint64_t spintables[] = {
184 0, 0, 0, 0
185 };
186
187 rom_add_blob_fixed_as("raspi_smpboot", smpboot, sizeof(smpboot),
188 info->smp_loader_start, as);
189 rom_add_blob_fixed_as("raspi_spintables", spintables, sizeof(spintables),
190 SPINTABLE_ADDR, as);
191 }
192
193 static void write_board_setup(ARMCPU *cpu, const struct arm_boot_info *info)
194 {
195 arm_write_secure_board_setup_dummy_smc(cpu, info, MVBAR_ADDR);
196 }
197
198 static void reset_secondary(ARMCPU *cpu, const struct arm_boot_info *info)
199 {
200 CPUState *cs = CPU(cpu);
201 cpu_set_pc(cs, info->smp_loader_start);
202 }
203
204 static void setup_boot(MachineState *machine, int version, size_t ram_size)
205 {
206 RaspiMachineState *s = RASPI_MACHINE(machine);
207 int r;
208
209 s->binfo.board_id = MACH_TYPE_BCM2708;
210 s->binfo.ram_size = ram_size;
211 s->binfo.nb_cpus = machine->smp.cpus;
212
213 if (version <= 2) {
214 /* The rpi1 and 2 require some custom setup code to run in Secure
215 * mode before booting a kernel (to set up the SMC vectors so
216 * that we get a no-op SMC; this is used by Linux to call the
217 * firmware for some cache maintenance operations.
218 * The rpi3 doesn't need this.
219 */
220 s->binfo.board_setup_addr = BOARDSETUP_ADDR;
221 s->binfo.write_board_setup = write_board_setup;
222 s->binfo.secure_board_setup = true;
223 s->binfo.secure_boot = true;
224 }
225
226 /* Pi2 and Pi3 requires SMP setup */
227 if (version >= 2) {
228 s->binfo.smp_loader_start = SMPBOOT_ADDR;
229 if (version == 2) {
230 s->binfo.write_secondary_boot = write_smpboot;
231 } else {
232 s->binfo.write_secondary_boot = write_smpboot64;
233 }
234 s->binfo.secondary_cpu_reset_hook = reset_secondary;
235 }
236
237 /* If the user specified a "firmware" image (e.g. UEFI), we bypass
238 * the normal Linux boot process
239 */
240 if (machine->firmware) {
241 hwaddr firmware_addr = processor_id <= PROCESSOR_ID_BCM2836
242 ? FIRMWARE_ADDR_2 : FIRMWARE_ADDR_3;
243 /* load the firmware image (typically kernel.img) */
244 r = load_image_targphys(machine->firmware, firmware_addr,
245 ram_size - firmware_addr);
246 if (r < 0) {
247 error_report("Failed to load firmware from %s", machine->firmware);
248 exit(1);
249 }
250
251 s->binfo.entry = firmware_addr;
252 s->binfo.firmware_loaded = true;
253 }
254
255 arm_load_kernel(&s->soc.cpu[0].core, machine, &s->binfo);
256 }
257
258 static void raspi_machine_init(MachineState *machine)
259 {
260 RaspiMachineClass *mc = RASPI_MACHINE_GET_CLASS(machine);
261 RaspiMachineState *s = RASPI_MACHINE(machine);
262 uint32_t board_rev = mc->board_rev;
263 int version = board_version(board_rev);
264 uint64_t ram_size = board_ram_size(board_rev);
265 uint32_t vcram_size;
266 DriveInfo *di;
267 BlockBackend *blk;
268 BusState *bus;
269 DeviceState *carddev;
270
271 if (machine->ram_size != ram_size) {
272 char *size_str = size_to_str(ram_size);
273 error_report("Invalid RAM size, should be %s", size_str);
274 g_free(size_str);
275 exit(1);
276 }
277
278 /* FIXME: Remove when we have custom CPU address space support */
279 memory_region_add_subregion_overlap(get_system_memory(), 0,
280 machine->ram, 0);
281
282 /* Setup the SOC */
283 object_initialize_child(OBJECT(machine), "soc", &s->soc,
284 board_soc_type(board_rev));
285 object_property_add_const_link(OBJECT(&s->soc), "ram", OBJECT(machine->ram));
286 object_property_set_int(OBJECT(&s->soc), "board-rev", board_rev,
287 &error_abort);
288 qdev_realize(DEVICE(&s->soc), NULL, &error_abort);
289
290 /* Create and plug in the SD cards */
291 di = drive_get_next(IF_SD);
292 blk = di ? blk_by_legacy_dinfo(di) : NULL;
293 bus = qdev_get_child_bus(DEVICE(&s->soc), "sd-bus");
294 if (bus == NULL) {
295 error_report("No SD bus found in SOC object");
296 exit(1);
297 }
298 carddev = qdev_new(TYPE_SD_CARD);
299 qdev_prop_set_drive_err(carddev, "drive", blk, &error_fatal);
300 qdev_realize_and_unref(carddev, bus, &error_fatal);
301
302 vcram_size = object_property_get_uint(OBJECT(&s->soc), "vcram-size",
303 &error_abort);
304 setup_boot(machine, version, machine->ram_size - vcram_size);
305 }
306
307 static void raspi_machine_class_common_init(MachineClass *mc,
308 uint32_t board_rev)
309 {
310 mc->desc = g_strdup_printf("Raspberry Pi %s (revision 1.%u)",
311 board_type(board_rev),
312 FIELD_EX32(board_rev, REV_CODE, REVISION));
313 mc->init = raspi_machine_init;
314 mc->block_default_type = IF_SD;
315 mc->no_parallel = 1;
316 mc->no_floppy = 1;
317 mc->no_cdrom = 1;
318 mc->default_cpus = mc->min_cpus = mc->max_cpus = cores_count(board_rev);
319 mc->default_ram_size = board_ram_size(board_rev);
320 mc->default_ram_id = "ram";
321 };
322
323 static void raspi2b_machine_class_init(ObjectClass *oc, void *data)
324 {
325 MachineClass *mc = MACHINE_CLASS(oc);
326 RaspiMachineClass *rmc = RASPI_MACHINE_CLASS(oc);
327
328 mc->alias = "raspi2";
329 rmc->board_rev = 0xa21041;
330 raspi_machine_class_common_init(mc, rmc->board_rev);
331 };
332
333 #ifdef TARGET_AARCH64
334 static void raspi3b_machine_class_init(ObjectClass *oc, void *data)
335 {
336 MachineClass *mc = MACHINE_CLASS(oc);
337 RaspiMachineClass *rmc = RASPI_MACHINE_CLASS(oc);
338
339 mc->alias = "raspi3";
340 rmc->board_rev = 0xa02082;
341 raspi_machine_class_common_init(mc, rmc->board_rev);
342 };
343 #endif /* TARGET_AARCH64 */
344
345 static const TypeInfo raspi_machine_types[] = {
346 {
347 .name = MACHINE_TYPE_NAME("raspi2b"),
348 .parent = TYPE_RASPI_MACHINE,
349 .class_init = raspi2b_machine_class_init,
350 #ifdef TARGET_AARCH64
351 }, {
352 .name = MACHINE_TYPE_NAME("raspi3b"),
353 .parent = TYPE_RASPI_MACHINE,
354 .class_init = raspi3b_machine_class_init,
355 #endif
356 }, {
357 .name = TYPE_RASPI_MACHINE,
358 .parent = TYPE_MACHINE,
359 .instance_size = sizeof(RaspiMachineState),
360 .class_size = sizeof(RaspiMachineClass),
361 .abstract = true,
362 }
363 };
364
365 DEFINE_TYPES(raspi_machine_types)