vl: extract qemu_init_subsystems
[qemu.git] / hw / arm / mps2.c
blob9a8b23c64ce70f7eac5ca1b4ae8ca778aa09a9ba
1 /*
2 * ARM V2M MPS2 board emulation.
4 * Copyright (c) 2017 Linaro Limited
5 * Written by Peter Maydell
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 or
9 * (at your option) any later version.
12 /* The MPS2 and MPS2+ dev boards are FPGA based (the 2+ has a bigger
13 * FPGA but is otherwise the same as the 2). Since the CPU itself
14 * and most of the devices are in the FPGA, the details of the board
15 * as seen by the guest depend significantly on the FPGA image.
16 * We model the following FPGA images:
17 * "mps2-an385" -- Cortex-M3 as documented in ARM Application Note AN385
18 * "mps2-an386" -- Cortex-M4 as documented in ARM Application Note AN386
19 * "mps2-an500" -- Cortex-M7 as documented in ARM Application Note AN500
20 * "mps2-an511" -- Cortex-M3 'DesignStart' as documented in AN511
22 * Links to the TRM for the board itself and to the various Application
23 * Notes which document the FPGA images can be found here:
24 * https://developer.arm.com/products/system-design/development-boards/cortex-m-prototyping-system
27 #include "qemu/osdep.h"
28 #include "qemu/units.h"
29 #include "qemu/cutils.h"
30 #include "qapi/error.h"
31 #include "qemu/error-report.h"
32 #include "hw/arm/boot.h"
33 #include "hw/arm/armv7m.h"
34 #include "hw/or-irq.h"
35 #include "hw/boards.h"
36 #include "exec/address-spaces.h"
37 #include "sysemu/sysemu.h"
38 #include "hw/misc/unimp.h"
39 #include "hw/char/cmsdk-apb-uart.h"
40 #include "hw/timer/cmsdk-apb-timer.h"
41 #include "hw/timer/cmsdk-apb-dualtimer.h"
42 #include "hw/misc/mps2-scc.h"
43 #include "hw/misc/mps2-fpgaio.h"
44 #include "hw/ssi/pl022.h"
45 #include "hw/i2c/arm_sbcon_i2c.h"
46 #include "hw/net/lan9118.h"
47 #include "net/net.h"
48 #include "hw/watchdog/cmsdk-apb-watchdog.h"
49 #include "qom/object.h"
51 typedef enum MPS2FPGAType {
52 FPGA_AN385,
53 FPGA_AN386,
54 FPGA_AN500,
55 FPGA_AN511,
56 } MPS2FPGAType;
58 struct MPS2MachineClass {
59 MachineClass parent;
60 MPS2FPGAType fpga_type;
61 uint32_t scc_id;
62 bool has_block_ram;
63 hwaddr ethernet_base;
64 hwaddr psram_base;
67 struct MPS2MachineState {
68 MachineState parent;
70 ARMv7MState armv7m;
71 MemoryRegion ssram1;
72 MemoryRegion ssram1_m;
73 MemoryRegion ssram23;
74 MemoryRegion ssram23_m;
75 MemoryRegion blockram;
76 MemoryRegion blockram_m1;
77 MemoryRegion blockram_m2;
78 MemoryRegion blockram_m3;
79 MemoryRegion sram;
80 /* FPGA APB subsystem */
81 MPS2SCC scc;
82 MPS2FPGAIO fpgaio;
83 /* CMSDK APB subsystem */
84 CMSDKAPBDualTimer dualtimer;
85 CMSDKAPBWatchdog watchdog;
88 #define TYPE_MPS2_MACHINE "mps2"
89 #define TYPE_MPS2_AN385_MACHINE MACHINE_TYPE_NAME("mps2-an385")
90 #define TYPE_MPS2_AN386_MACHINE MACHINE_TYPE_NAME("mps2-an386")
91 #define TYPE_MPS2_AN500_MACHINE MACHINE_TYPE_NAME("mps2-an500")
92 #define TYPE_MPS2_AN511_MACHINE MACHINE_TYPE_NAME("mps2-an511")
94 OBJECT_DECLARE_TYPE(MPS2MachineState, MPS2MachineClass, MPS2_MACHINE)
96 /* Main SYSCLK frequency in Hz */
97 #define SYSCLK_FRQ 25000000
99 /* Initialize the auxiliary RAM region @mr and map it into
100 * the memory map at @base.
102 static void make_ram(MemoryRegion *mr, const char *name,
103 hwaddr base, hwaddr size)
105 memory_region_init_ram(mr, NULL, name, size, &error_fatal);
106 memory_region_add_subregion(get_system_memory(), base, mr);
109 /* Create an alias of an entire original MemoryRegion @orig
110 * located at @base in the memory map.
112 static void make_ram_alias(MemoryRegion *mr, const char *name,
113 MemoryRegion *orig, hwaddr base)
115 memory_region_init_alias(mr, NULL, name, orig, 0,
116 memory_region_size(orig));
117 memory_region_add_subregion(get_system_memory(), base, mr);
120 static void mps2_common_init(MachineState *machine)
122 MPS2MachineState *mms = MPS2_MACHINE(machine);
123 MPS2MachineClass *mmc = MPS2_MACHINE_GET_CLASS(machine);
124 MemoryRegion *system_memory = get_system_memory();
125 MachineClass *mc = MACHINE_GET_CLASS(machine);
126 DeviceState *armv7m, *sccdev;
127 int i;
129 if (strcmp(machine->cpu_type, mc->default_cpu_type) != 0) {
130 error_report("This board can only be used with CPU %s",
131 mc->default_cpu_type);
132 exit(1);
135 if (machine->ram_size != mc->default_ram_size) {
136 char *sz = size_to_str(mc->default_ram_size);
137 error_report("Invalid RAM size, should be %s", sz);
138 g_free(sz);
139 exit(EXIT_FAILURE);
142 /* The FPGA images have an odd combination of different RAMs,
143 * because in hardware they are different implementations and
144 * connected to different buses, giving varying performance/size
145 * tradeoffs. For QEMU they're all just RAM, though. We arbitrarily
146 * call the 16MB our "system memory", as it's the largest lump.
148 * AN385/AN386/AN511:
149 * 0x21000000 .. 0x21ffffff : PSRAM (16MB)
150 * AN385/AN386/AN500:
151 * 0x00000000 .. 0x003fffff : ZBT SSRAM1
152 * 0x00400000 .. 0x007fffff : mirror of ZBT SSRAM1
153 * 0x20000000 .. 0x203fffff : ZBT SSRAM 2&3
154 * 0x20400000 .. 0x207fffff : mirror of ZBT SSRAM 2&3
155 * AN385/AN386 only:
156 * 0x01000000 .. 0x01003fff : block RAM (16K)
157 * 0x01004000 .. 0x01007fff : mirror of above
158 * 0x01008000 .. 0x0100bfff : mirror of above
159 * 0x0100c000 .. 0x0100ffff : mirror of above
160 * AN511 only:
161 * 0x00000000 .. 0x0003ffff : FPGA block RAM
162 * 0x00400000 .. 0x007fffff : ZBT SSRAM1
163 * 0x20000000 .. 0x2001ffff : SRAM
164 * 0x20400000 .. 0x207fffff : ZBT SSRAM 2&3
165 * AN500 only:
166 * 0x60000000 .. 0x60ffffff : PSRAM (16MB)
168 * The AN385/AN386 has a feature where the lowest 16K can be mapped
169 * either to the bottom of the ZBT SSRAM1 or to the block RAM.
170 * This is of no use for QEMU so we don't implement it (as if
171 * zbt_boot_ctrl is always zero).
173 memory_region_add_subregion(system_memory, mmc->psram_base, machine->ram);
175 if (mmc->has_block_ram) {
176 make_ram(&mms->blockram, "mps.blockram", 0x01000000, 0x4000);
177 make_ram_alias(&mms->blockram_m1, "mps.blockram_m1",
178 &mms->blockram, 0x01004000);
179 make_ram_alias(&mms->blockram_m2, "mps.blockram_m2",
180 &mms->blockram, 0x01008000);
181 make_ram_alias(&mms->blockram_m3, "mps.blockram_m3",
182 &mms->blockram, 0x0100c000);
185 switch (mmc->fpga_type) {
186 case FPGA_AN385:
187 case FPGA_AN386:
188 case FPGA_AN500:
189 make_ram(&mms->ssram1, "mps.ssram1", 0x0, 0x400000);
190 make_ram_alias(&mms->ssram1_m, "mps.ssram1_m", &mms->ssram1, 0x400000);
191 make_ram(&mms->ssram23, "mps.ssram23", 0x20000000, 0x400000);
192 make_ram_alias(&mms->ssram23_m, "mps.ssram23_m",
193 &mms->ssram23, 0x20400000);
194 break;
195 case FPGA_AN511:
196 make_ram(&mms->blockram, "mps.blockram", 0x0, 0x40000);
197 make_ram(&mms->ssram1, "mps.ssram1", 0x00400000, 0x00800000);
198 make_ram(&mms->sram, "mps.sram", 0x20000000, 0x20000);
199 make_ram(&mms->ssram23, "mps.ssram23", 0x20400000, 0x400000);
200 break;
201 default:
202 g_assert_not_reached();
205 object_initialize_child(OBJECT(mms), "armv7m", &mms->armv7m, TYPE_ARMV7M);
206 armv7m = DEVICE(&mms->armv7m);
207 switch (mmc->fpga_type) {
208 case FPGA_AN385:
209 case FPGA_AN386:
210 case FPGA_AN500:
211 qdev_prop_set_uint32(armv7m, "num-irq", 32);
212 break;
213 case FPGA_AN511:
214 qdev_prop_set_uint32(armv7m, "num-irq", 64);
215 break;
216 default:
217 g_assert_not_reached();
219 qdev_prop_set_string(armv7m, "cpu-type", machine->cpu_type);
220 qdev_prop_set_bit(armv7m, "enable-bitband", true);
221 object_property_set_link(OBJECT(&mms->armv7m), "memory",
222 OBJECT(system_memory), &error_abort);
223 sysbus_realize(SYS_BUS_DEVICE(&mms->armv7m), &error_fatal);
225 create_unimplemented_device("zbtsmram mirror", 0x00400000, 0x00400000);
226 create_unimplemented_device("RESERVED 1", 0x00800000, 0x00800000);
227 create_unimplemented_device("Block RAM", 0x01000000, 0x00010000);
228 create_unimplemented_device("RESERVED 2", 0x01010000, 0x1EFF0000);
229 create_unimplemented_device("RESERVED 3", 0x20800000, 0x00800000);
230 create_unimplemented_device("PSRAM", 0x21000000, 0x01000000);
231 /* These three ranges all cover multiple devices; we may implement
232 * some of them below (in which case the real device takes precedence
233 * over the unimplemented-region mapping).
235 create_unimplemented_device("CMSDK APB peripheral region @0x40000000",
236 0x40000000, 0x00010000);
237 create_unimplemented_device("CMSDK AHB peripheral region @0x40010000",
238 0x40010000, 0x00010000);
239 create_unimplemented_device("Extra peripheral region @0x40020000",
240 0x40020000, 0x00010000);
242 create_unimplemented_device("RESERVED 4", 0x40030000, 0x001D0000);
243 create_unimplemented_device("VGA", 0x41000000, 0x0200000);
245 switch (mmc->fpga_type) {
246 case FPGA_AN385:
247 case FPGA_AN386:
248 case FPGA_AN500:
250 /* The overflow IRQs for UARTs 0, 1 and 2 are ORed together.
251 * Overflow for UARTs 4 and 5 doesn't trigger any interrupt.
253 Object *orgate;
254 DeviceState *orgate_dev;
256 orgate = object_new(TYPE_OR_IRQ);
257 object_property_set_int(orgate, "num-lines", 6, &error_fatal);
258 qdev_realize(DEVICE(orgate), NULL, &error_fatal);
259 orgate_dev = DEVICE(orgate);
260 qdev_connect_gpio_out(orgate_dev, 0, qdev_get_gpio_in(armv7m, 12));
262 for (i = 0; i < 5; i++) {
263 static const hwaddr uartbase[] = {0x40004000, 0x40005000,
264 0x40006000, 0x40007000,
265 0x40009000};
266 /* RX irq number; TX irq is always one greater */
267 static const int uartirq[] = {0, 2, 4, 18, 20};
268 qemu_irq txovrint = NULL, rxovrint = NULL;
270 if (i < 3) {
271 txovrint = qdev_get_gpio_in(orgate_dev, i * 2);
272 rxovrint = qdev_get_gpio_in(orgate_dev, i * 2 + 1);
275 cmsdk_apb_uart_create(uartbase[i],
276 qdev_get_gpio_in(armv7m, uartirq[i] + 1),
277 qdev_get_gpio_in(armv7m, uartirq[i]),
278 txovrint, rxovrint,
279 NULL,
280 serial_hd(i), SYSCLK_FRQ);
282 break;
284 case FPGA_AN511:
286 /* The overflow IRQs for all UARTs are ORed together.
287 * Tx and Rx IRQs for each UART are ORed together.
289 Object *orgate;
290 DeviceState *orgate_dev;
292 orgate = object_new(TYPE_OR_IRQ);
293 object_property_set_int(orgate, "num-lines", 10, &error_fatal);
294 qdev_realize(DEVICE(orgate), NULL, &error_fatal);
295 orgate_dev = DEVICE(orgate);
296 qdev_connect_gpio_out(orgate_dev, 0, qdev_get_gpio_in(armv7m, 12));
298 for (i = 0; i < 5; i++) {
299 /* system irq numbers for the combined tx/rx for each UART */
300 static const int uart_txrx_irqno[] = {0, 2, 45, 46, 56};
301 static const hwaddr uartbase[] = {0x40004000, 0x40005000,
302 0x4002c000, 0x4002d000,
303 0x4002e000};
304 Object *txrx_orgate;
305 DeviceState *txrx_orgate_dev;
307 txrx_orgate = object_new(TYPE_OR_IRQ);
308 object_property_set_int(txrx_orgate, "num-lines", 2, &error_fatal);
309 qdev_realize(DEVICE(txrx_orgate), NULL, &error_fatal);
310 txrx_orgate_dev = DEVICE(txrx_orgate);
311 qdev_connect_gpio_out(txrx_orgate_dev, 0,
312 qdev_get_gpio_in(armv7m, uart_txrx_irqno[i]));
313 cmsdk_apb_uart_create(uartbase[i],
314 qdev_get_gpio_in(txrx_orgate_dev, 0),
315 qdev_get_gpio_in(txrx_orgate_dev, 1),
316 qdev_get_gpio_in(orgate_dev, i * 2),
317 qdev_get_gpio_in(orgate_dev, i * 2 + 1),
318 NULL,
319 serial_hd(i), SYSCLK_FRQ);
321 break;
323 default:
324 g_assert_not_reached();
326 for (i = 0; i < 4; i++) {
327 static const hwaddr gpiobase[] = {0x40010000, 0x40011000,
328 0x40012000, 0x40013000};
329 create_unimplemented_device("cmsdk-ahb-gpio", gpiobase[i], 0x1000);
332 /* CMSDK APB subsystem */
333 cmsdk_apb_timer_create(0x40000000, qdev_get_gpio_in(armv7m, 8), SYSCLK_FRQ);
334 cmsdk_apb_timer_create(0x40001000, qdev_get_gpio_in(armv7m, 9), SYSCLK_FRQ);
335 object_initialize_child(OBJECT(mms), "dualtimer", &mms->dualtimer,
336 TYPE_CMSDK_APB_DUALTIMER);
337 qdev_prop_set_uint32(DEVICE(&mms->dualtimer), "pclk-frq", SYSCLK_FRQ);
338 sysbus_realize(SYS_BUS_DEVICE(&mms->dualtimer), &error_fatal);
339 sysbus_connect_irq(SYS_BUS_DEVICE(&mms->dualtimer), 0,
340 qdev_get_gpio_in(armv7m, 10));
341 sysbus_mmio_map(SYS_BUS_DEVICE(&mms->dualtimer), 0, 0x40002000);
342 object_initialize_child(OBJECT(mms), "watchdog", &mms->watchdog,
343 TYPE_CMSDK_APB_WATCHDOG);
344 qdev_prop_set_uint32(DEVICE(&mms->watchdog), "wdogclk-frq", SYSCLK_FRQ);
345 sysbus_realize(SYS_BUS_DEVICE(&mms->watchdog), &error_fatal);
346 sysbus_connect_irq(SYS_BUS_DEVICE(&mms->watchdog), 0,
347 qdev_get_gpio_in_named(armv7m, "NMI", 0));
348 sysbus_mmio_map(SYS_BUS_DEVICE(&mms->watchdog), 0, 0x40008000);
350 /* FPGA APB subsystem */
351 object_initialize_child(OBJECT(mms), "scc", &mms->scc, TYPE_MPS2_SCC);
352 sccdev = DEVICE(&mms->scc);
353 qdev_prop_set_uint32(sccdev, "scc-cfg4", 0x2);
354 qdev_prop_set_uint32(sccdev, "scc-aid", 0x00200008);
355 qdev_prop_set_uint32(sccdev, "scc-id", mmc->scc_id);
356 sysbus_realize(SYS_BUS_DEVICE(&mms->scc), &error_fatal);
357 sysbus_mmio_map(SYS_BUS_DEVICE(sccdev), 0, 0x4002f000);
358 object_initialize_child(OBJECT(mms), "fpgaio",
359 &mms->fpgaio, TYPE_MPS2_FPGAIO);
360 qdev_prop_set_uint32(DEVICE(&mms->fpgaio), "prescale-clk", 25000000);
361 sysbus_realize(SYS_BUS_DEVICE(&mms->fpgaio), &error_fatal);
362 sysbus_mmio_map(SYS_BUS_DEVICE(&mms->fpgaio), 0, 0x40028000);
363 sysbus_create_simple(TYPE_PL022, 0x40025000, /* External ADC */
364 qdev_get_gpio_in(armv7m, 22));
365 for (i = 0; i < 2; i++) {
366 static const int spi_irqno[] = {11, 24};
367 static const hwaddr spibase[] = {0x40020000, /* APB */
368 0x40021000, /* LCD */
369 0x40026000, /* Shield0 */
370 0x40027000}; /* Shield1 */
371 DeviceState *orgate_dev;
372 Object *orgate;
373 int j;
375 orgate = object_new(TYPE_OR_IRQ);
376 object_property_set_int(orgate, "num-lines", 2, &error_fatal);
377 orgate_dev = DEVICE(orgate);
378 qdev_realize(orgate_dev, NULL, &error_fatal);
379 qdev_connect_gpio_out(orgate_dev, 0,
380 qdev_get_gpio_in(armv7m, spi_irqno[i]));
381 for (j = 0; j < 2; j++) {
382 sysbus_create_simple(TYPE_PL022, spibase[2 * i + j],
383 qdev_get_gpio_in(orgate_dev, j));
386 for (i = 0; i < 4; i++) {
387 static const hwaddr i2cbase[] = {0x40022000, /* Touch */
388 0x40023000, /* Audio */
389 0x40029000, /* Shield0 */
390 0x4002a000}; /* Shield1 */
391 sysbus_create_simple(TYPE_ARM_SBCON_I2C, i2cbase[i], NULL);
393 create_unimplemented_device("i2s", 0x40024000, 0x400);
395 /* In hardware this is a LAN9220; the LAN9118 is software compatible
396 * except that it doesn't support the checksum-offload feature.
398 lan9118_init(&nd_table[0], mmc->ethernet_base,
399 qdev_get_gpio_in(armv7m,
400 mmc->fpga_type == FPGA_AN511 ? 47 : 13));
402 system_clock_scale = NANOSECONDS_PER_SECOND / SYSCLK_FRQ;
404 armv7m_load_kernel(ARM_CPU(first_cpu), machine->kernel_filename,
405 0x400000);
408 static void mps2_class_init(ObjectClass *oc, void *data)
410 MachineClass *mc = MACHINE_CLASS(oc);
412 mc->init = mps2_common_init;
413 mc->max_cpus = 1;
414 mc->default_ram_size = 16 * MiB;
415 mc->default_ram_id = "mps.ram";
418 static void mps2_an385_class_init(ObjectClass *oc, void *data)
420 MachineClass *mc = MACHINE_CLASS(oc);
421 MPS2MachineClass *mmc = MPS2_MACHINE_CLASS(oc);
423 mc->desc = "ARM MPS2 with AN385 FPGA image for Cortex-M3";
424 mmc->fpga_type = FPGA_AN385;
425 mc->default_cpu_type = ARM_CPU_TYPE_NAME("cortex-m3");
426 mmc->scc_id = 0x41043850;
427 mmc->psram_base = 0x21000000;
428 mmc->ethernet_base = 0x40200000;
429 mmc->has_block_ram = true;
432 static void mps2_an386_class_init(ObjectClass *oc, void *data)
434 MachineClass *mc = MACHINE_CLASS(oc);
435 MPS2MachineClass *mmc = MPS2_MACHINE_CLASS(oc);
437 mc->desc = "ARM MPS2 with AN386 FPGA image for Cortex-M4";
438 mmc->fpga_type = FPGA_AN386;
439 mc->default_cpu_type = ARM_CPU_TYPE_NAME("cortex-m4");
440 mmc->scc_id = 0x41043860;
441 mmc->psram_base = 0x21000000;
442 mmc->ethernet_base = 0x40200000;
443 mmc->has_block_ram = true;
446 static void mps2_an500_class_init(ObjectClass *oc, void *data)
448 MachineClass *mc = MACHINE_CLASS(oc);
449 MPS2MachineClass *mmc = MPS2_MACHINE_CLASS(oc);
451 mc->desc = "ARM MPS2 with AN500 FPGA image for Cortex-M7";
452 mmc->fpga_type = FPGA_AN500;
453 mc->default_cpu_type = ARM_CPU_TYPE_NAME("cortex-m7");
454 mmc->scc_id = 0x41045000;
455 mmc->psram_base = 0x60000000;
456 mmc->ethernet_base = 0xa0000000;
457 mmc->has_block_ram = false;
460 static void mps2_an511_class_init(ObjectClass *oc, void *data)
462 MachineClass *mc = MACHINE_CLASS(oc);
463 MPS2MachineClass *mmc = MPS2_MACHINE_CLASS(oc);
465 mc->desc = "ARM MPS2 with AN511 DesignStart FPGA image for Cortex-M3";
466 mmc->fpga_type = FPGA_AN511;
467 mc->default_cpu_type = ARM_CPU_TYPE_NAME("cortex-m3");
468 mmc->scc_id = 0x41045110;
469 mmc->psram_base = 0x21000000;
470 mmc->ethernet_base = 0x40200000;
471 mmc->has_block_ram = false;
474 static const TypeInfo mps2_info = {
475 .name = TYPE_MPS2_MACHINE,
476 .parent = TYPE_MACHINE,
477 .abstract = true,
478 .instance_size = sizeof(MPS2MachineState),
479 .class_size = sizeof(MPS2MachineClass),
480 .class_init = mps2_class_init,
483 static const TypeInfo mps2_an385_info = {
484 .name = TYPE_MPS2_AN385_MACHINE,
485 .parent = TYPE_MPS2_MACHINE,
486 .class_init = mps2_an385_class_init,
489 static const TypeInfo mps2_an386_info = {
490 .name = TYPE_MPS2_AN386_MACHINE,
491 .parent = TYPE_MPS2_MACHINE,
492 .class_init = mps2_an386_class_init,
495 static const TypeInfo mps2_an500_info = {
496 .name = TYPE_MPS2_AN500_MACHINE,
497 .parent = TYPE_MPS2_MACHINE,
498 .class_init = mps2_an500_class_init,
501 static const TypeInfo mps2_an511_info = {
502 .name = TYPE_MPS2_AN511_MACHINE,
503 .parent = TYPE_MPS2_MACHINE,
504 .class_init = mps2_an511_class_init,
507 static void mps2_machine_init(void)
509 type_register_static(&mps2_info);
510 type_register_static(&mps2_an385_info);
511 type_register_static(&mps2_an386_info);
512 type_register_static(&mps2_an500_info);
513 type_register_static(&mps2_an511_info);
516 type_init(mps2_machine_init);