1 /* 2 * QEMU RISC-V Board Compatible with OpenTitan FPGA platform 3 * 4 * Copyright (c) 2020 Western Digital 5 * 6 * Provides a board compatible with the OpenTitan FPGA platform: 7 * 8 * This program is free software; you can redistribute it and/or modify it 9 * under the terms and conditions of the GNU General Public License, 10 * version 2 or later, as published by the Free Software Foundation. 11 * 12 * This program is distributed in the hope it will be useful, but WITHOUT 13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 15 * more details. 16 * 17 * You should have received a copy of the GNU General Public License along with 18 * this program. If not, see <http://www.gnu.org/licenses/>. 19 */ 20 21 #include "qemu/osdep.h" 22 #include "qemu/cutils.h" 23 #include "hw/riscv/opentitan.h" 24 #include "qapi/error.h" 25 #include "qemu/error-report.h" 26 #include "hw/boards.h" 27 #include "hw/misc/unimp.h" 28 #include "hw/riscv/boot.h" 29 #include "qemu/units.h" 30 #include "system/system.h" 31 32 /* 33 * This version of the OpenTitan machine currently supports 34 * OpenTitan RTL version: 35 * <lowRISC/opentitan@565e4af39760a123c59a184aa2f5812a961fde47> 36 * 37 * MMIO mapping as per (specified commit): 38 * lowRISC/opentitan: hw/top_earlgrey/sw/autogen/top_earlgrey_memory.h 39 */ 40 static const MemMapEntry ibex_memmap[] = { 41 [IBEX_DEV_ROM] = { 0x00008000, 0x8000 }, 42 [IBEX_DEV_RAM] = { 0x10000000, 0x20000 }, 43 [IBEX_DEV_FLASH] = { 0x20000000, 0x100000 }, 44 [IBEX_DEV_UART] = { 0x40000000, 0x40 }, 45 [IBEX_DEV_GPIO] = { 0x40040000, 0x40 }, 46 [IBEX_DEV_SPI_DEVICE] = { 0x40050000, 0x2000 }, 47 [IBEX_DEV_I2C] = { 0x40080000, 0x80 }, 48 [IBEX_DEV_PATTGEN] = { 0x400e0000, 0x40 }, 49 [IBEX_DEV_TIMER] = { 0x40100000, 0x200 }, 50 [IBEX_DEV_OTP_CTRL] = { 0x40130000, 0x2000 }, 51 [IBEX_DEV_LC_CTRL] = { 0x40140000, 0x100 }, 52 [IBEX_DEV_ALERT_HANDLER] = { 0x40150000, 0x800 }, 53 [IBEX_DEV_SPI_HOST0] = { 0x40300000, 0x40 }, 54 [IBEX_DEV_SPI_HOST1] = { 0x40310000, 0x40 }, 55 [IBEX_DEV_USBDEV] = { 0x40320000, 0x1000 }, 56 [IBEX_DEV_PWRMGR] = { 0x40400000, 0x80 }, 57 [IBEX_DEV_RSTMGR] = { 0x40410000, 0x80 }, 58 [IBEX_DEV_CLKMGR] = { 0x40420000, 0x80 }, 59 [IBEX_DEV_PINMUX] = { 0x40460000, 0x1000 }, 60 [IBEX_DEV_AON_TIMER] = { 0x40470000, 0x40 }, 61 [IBEX_DEV_SENSOR_CTRL] = { 0x40490000, 0x40 }, 62 [IBEX_DEV_FLASH_CTRL] = { 0x41000000, 0x200 }, 63 [IBEX_DEV_AES] = { 0x41100000, 0x100 }, 64 [IBEX_DEV_HMAC] = { 0x41110000, 0x1000 }, 65 [IBEX_DEV_KMAC] = { 0x41120000, 0x1000 }, 66 [IBEX_DEV_OTBN] = { 0x41130000, 0x10000 }, 67 [IBEX_DEV_KEYMGR] = { 0x41140000, 0x100 }, 68 [IBEX_DEV_CSRNG] = { 0x41150000, 0x80 }, 69 [IBEX_DEV_ENTROPY] = { 0x41160000, 0x100 }, 70 [IBEX_DEV_EDNO] = { 0x41170000, 0x80 }, 71 [IBEX_DEV_EDN1] = { 0x41180000, 0x80 }, 72 [IBEX_DEV_SRAM_CTRL] = { 0x411c0000, 0x20 }, 73 [IBEX_DEV_IBEX_CFG] = { 0x411f0000, 0x100 }, 74 [IBEX_DEV_PLIC] = { 0x48000000, 0x8000000 }, 75 [IBEX_DEV_FLASH_VIRTUAL] = { 0x80000000, 0x80000 }, 76 }; 77 78 static void opentitan_machine_init(MachineState *machine) 79 { 80 MachineClass *mc = MACHINE_GET_CLASS(machine); 81 OpenTitanState *s = OPENTITAN_MACHINE(machine); 82 const MemMapEntry *memmap = ibex_memmap; 83 MemoryRegion *sys_mem = get_system_memory(); 84 RISCVBootInfo boot_info; 85 86 if (machine->ram_size != mc->default_ram_size) { 87 char *sz = size_to_str(mc->default_ram_size); 88 error_report("Invalid RAM size, should be %s", sz); 89 g_free(sz); 90 exit(EXIT_FAILURE); 91 } 92 93 /* Initialize SoC */ 94 object_initialize_child(OBJECT(machine), "soc", &s->soc, 95 TYPE_RISCV_IBEX_SOC); 96 qdev_realize(DEVICE(&s->soc), NULL, &error_fatal); 97 98 memory_region_add_subregion(sys_mem, 99 memmap[IBEX_DEV_RAM].base, machine->ram); 100 101 if (machine->firmware) { 102 hwaddr firmware_load_addr = memmap[IBEX_DEV_RAM].base; 103 riscv_load_firmware(machine->firmware, &firmware_load_addr, NULL); 104 } 105 106 riscv_boot_info_init(&boot_info, &s->soc.cpus); 107 if (machine->kernel_filename) { 108 riscv_load_kernel(machine, &boot_info, 109 memmap[IBEX_DEV_RAM].base, 110 false, NULL); 111 } 112 } 113 114 static void opentitan_machine_class_init(ObjectClass *oc, void *data) 115 { 116 MachineClass *mc = MACHINE_CLASS(oc); 117 118 mc->desc = "RISC-V Board compatible with OpenTitan"; 119 mc->init = opentitan_machine_init; 120 mc->max_cpus = 1; 121 mc->default_cpu_type = TYPE_RISCV_CPU_IBEX; 122 mc->default_ram_id = "riscv.lowrisc.ibex.ram"; 123 mc->default_ram_size = ibex_memmap[IBEX_DEV_RAM].size; 124 } 125 126 static void lowrisc_ibex_soc_init(Object *obj) 127 { 128 LowRISCIbexSoCState *s = RISCV_IBEX_SOC(obj); 129 130 object_initialize_child(obj, "cpus", &s->cpus, TYPE_RISCV_HART_ARRAY); 131 132 object_initialize_child(obj, "plic", &s->plic, TYPE_SIFIVE_PLIC); 133 134 object_initialize_child(obj, "uart", &s->uart, TYPE_IBEX_UART); 135 136 object_initialize_child(obj, "timer", &s->timer, TYPE_IBEX_TIMER); 137 138 for (int i = 0; i < OPENTITAN_NUM_SPI_HOSTS; i++) { 139 object_initialize_child(obj, "spi_host[*]", &s->spi_host[i], 140 TYPE_IBEX_SPI_HOST); 141 } 142 } 143 144 static void lowrisc_ibex_soc_realize(DeviceState *dev_soc, Error **errp) 145 { 146 const MemMapEntry *memmap = ibex_memmap; 147 DeviceState *dev; 148 SysBusDevice *busdev; 149 MachineState *ms = MACHINE(qdev_get_machine()); 150 LowRISCIbexSoCState *s = RISCV_IBEX_SOC(dev_soc); 151 MemoryRegion *sys_mem = get_system_memory(); 152 int i; 153 154 object_property_set_str(OBJECT(&s->cpus), "cpu-type", ms->cpu_type, 155 &error_abort); 156 object_property_set_int(OBJECT(&s->cpus), "num-harts", ms->smp.cpus, 157 &error_abort); 158 object_property_set_int(OBJECT(&s->cpus), "resetvec", s->resetvec, 159 &error_abort); 160 sysbus_realize(SYS_BUS_DEVICE(&s->cpus), &error_fatal); 161 162 /* Boot ROM */ 163 memory_region_init_rom(&s->rom, OBJECT(dev_soc), "riscv.lowrisc.ibex.rom", 164 memmap[IBEX_DEV_ROM].size, &error_fatal); 165 memory_region_add_subregion(sys_mem, 166 memmap[IBEX_DEV_ROM].base, &s->rom); 167 168 /* Flash memory */ 169 memory_region_init_rom(&s->flash_mem, OBJECT(dev_soc), "riscv.lowrisc.ibex.flash", 170 memmap[IBEX_DEV_FLASH].size, &error_fatal); 171 memory_region_init_alias(&s->flash_alias, OBJECT(dev_soc), 172 "riscv.lowrisc.ibex.flash_virtual", &s->flash_mem, 0, 173 memmap[IBEX_DEV_FLASH_VIRTUAL].size); 174 memory_region_add_subregion(sys_mem, memmap[IBEX_DEV_FLASH].base, 175 &s->flash_mem); 176 memory_region_add_subregion(sys_mem, memmap[IBEX_DEV_FLASH_VIRTUAL].base, 177 &s->flash_alias); 178 179 /* PLIC */ 180 qdev_prop_set_string(DEVICE(&s->plic), "hart-config", "M"); 181 qdev_prop_set_uint32(DEVICE(&s->plic), "num-sources", 180); 182 qdev_prop_set_uint32(DEVICE(&s->plic), "num-priorities", 3); 183 qdev_prop_set_uint32(DEVICE(&s->plic), "pending-base", 0x1000); 184 qdev_prop_set_uint32(DEVICE(&s->plic), "enable-base", 0x2000); 185 qdev_prop_set_uint32(DEVICE(&s->plic), "enable-stride", 32); 186 qdev_prop_set_uint32(DEVICE(&s->plic), "context-base", 0x200000); 187 qdev_prop_set_uint32(DEVICE(&s->plic), "context-stride", 8); 188 qdev_prop_set_uint32(DEVICE(&s->plic), "aperture-size", memmap[IBEX_DEV_PLIC].size); 189 190 if (!sysbus_realize(SYS_BUS_DEVICE(&s->plic), errp)) { 191 return; 192 } 193 sysbus_mmio_map(SYS_BUS_DEVICE(&s->plic), 0, memmap[IBEX_DEV_PLIC].base); 194 195 for (i = 0; i < ms->smp.cpus; i++) { 196 CPUState *cpu = qemu_get_cpu(i); 197 198 qdev_connect_gpio_out(DEVICE(&s->plic), ms->smp.cpus + i, 199 qdev_get_gpio_in(DEVICE(cpu), IRQ_M_EXT)); 200 } 201 202 /* UART */ 203 qdev_prop_set_chr(DEVICE(&(s->uart)), "chardev", serial_hd(0)); 204 if (!sysbus_realize(SYS_BUS_DEVICE(&s->uart), errp)) { 205 return; 206 } 207 sysbus_mmio_map(SYS_BUS_DEVICE(&s->uart), 0, memmap[IBEX_DEV_UART].base); 208 sysbus_connect_irq(SYS_BUS_DEVICE(&s->uart), 209 0, qdev_get_gpio_in(DEVICE(&s->plic), 210 IBEX_UART0_TX_WATERMARK_IRQ)); 211 sysbus_connect_irq(SYS_BUS_DEVICE(&s->uart), 212 1, qdev_get_gpio_in(DEVICE(&s->plic), 213 IBEX_UART0_RX_WATERMARK_IRQ)); 214 sysbus_connect_irq(SYS_BUS_DEVICE(&s->uart), 215 2, qdev_get_gpio_in(DEVICE(&s->plic), 216 IBEX_UART0_TX_EMPTY_IRQ)); 217 sysbus_connect_irq(SYS_BUS_DEVICE(&s->uart), 218 3, qdev_get_gpio_in(DEVICE(&s->plic), 219 IBEX_UART0_RX_OVERFLOW_IRQ)); 220 221 if (!sysbus_realize(SYS_BUS_DEVICE(&s->timer), errp)) { 222 return; 223 } 224 sysbus_mmio_map(SYS_BUS_DEVICE(&s->timer), 0, memmap[IBEX_DEV_TIMER].base); 225 sysbus_connect_irq(SYS_BUS_DEVICE(&s->timer), 226 0, qdev_get_gpio_in(DEVICE(&s->plic), 227 IBEX_TIMER_TIMEREXPIRED0_0)); 228 qdev_connect_gpio_out(DEVICE(&s->timer), 0, 229 qdev_get_gpio_in(DEVICE(qemu_get_cpu(0)), 230 IRQ_M_TIMER)); 231 232 /* SPI-Hosts */ 233 for (i = 0; i < OPENTITAN_NUM_SPI_HOSTS; ++i) { 234 dev = DEVICE(&(s->spi_host[i])); 235 if (!sysbus_realize(SYS_BUS_DEVICE(&s->spi_host[i]), errp)) { 236 return; 237 } 238 busdev = SYS_BUS_DEVICE(dev); 239 sysbus_mmio_map(busdev, 0, memmap[IBEX_DEV_SPI_HOST0 + i].base); 240 241 switch (i) { 242 case OPENTITAN_SPI_HOST0: 243 sysbus_connect_irq(busdev, 0, qdev_get_gpio_in(DEVICE(&s->plic), 244 IBEX_SPI_HOST0_ERR_IRQ)); 245 sysbus_connect_irq(busdev, 1, qdev_get_gpio_in(DEVICE(&s->plic), 246 IBEX_SPI_HOST0_SPI_EVENT_IRQ)); 247 break; 248 case OPENTITAN_SPI_HOST1: 249 sysbus_connect_irq(busdev, 0, qdev_get_gpio_in(DEVICE(&s->plic), 250 IBEX_SPI_HOST1_ERR_IRQ)); 251 sysbus_connect_irq(busdev, 1, qdev_get_gpio_in(DEVICE(&s->plic), 252 IBEX_SPI_HOST1_SPI_EVENT_IRQ)); 253 break; 254 } 255 } 256 257 create_unimplemented_device("riscv.lowrisc.ibex.gpio", 258 memmap[IBEX_DEV_GPIO].base, memmap[IBEX_DEV_GPIO].size); 259 create_unimplemented_device("riscv.lowrisc.ibex.spi_device", 260 memmap[IBEX_DEV_SPI_DEVICE].base, memmap[IBEX_DEV_SPI_DEVICE].size); 261 create_unimplemented_device("riscv.lowrisc.ibex.i2c", 262 memmap[IBEX_DEV_I2C].base, memmap[IBEX_DEV_I2C].size); 263 create_unimplemented_device("riscv.lowrisc.ibex.pattgen", 264 memmap[IBEX_DEV_PATTGEN].base, memmap[IBEX_DEV_PATTGEN].size); 265 create_unimplemented_device("riscv.lowrisc.ibex.sensor_ctrl", 266 memmap[IBEX_DEV_SENSOR_CTRL].base, memmap[IBEX_DEV_SENSOR_CTRL].size); 267 create_unimplemented_device("riscv.lowrisc.ibex.otp_ctrl", 268 memmap[IBEX_DEV_OTP_CTRL].base, memmap[IBEX_DEV_OTP_CTRL].size); 269 create_unimplemented_device("riscv.lowrisc.ibex.lc_ctrl", 270 memmap[IBEX_DEV_LC_CTRL].base, memmap[IBEX_DEV_LC_CTRL].size); 271 create_unimplemented_device("riscv.lowrisc.ibex.pwrmgr", 272 memmap[IBEX_DEV_PWRMGR].base, memmap[IBEX_DEV_PWRMGR].size); 273 create_unimplemented_device("riscv.lowrisc.ibex.rstmgr", 274 memmap[IBEX_DEV_RSTMGR].base, memmap[IBEX_DEV_RSTMGR].size); 275 create_unimplemented_device("riscv.lowrisc.ibex.clkmgr", 276 memmap[IBEX_DEV_CLKMGR].base, memmap[IBEX_DEV_CLKMGR].size); 277 create_unimplemented_device("riscv.lowrisc.ibex.pinmux", 278 memmap[IBEX_DEV_PINMUX].base, memmap[IBEX_DEV_PINMUX].size); 279 create_unimplemented_device("riscv.lowrisc.ibex.aon_timer", 280 memmap[IBEX_DEV_AON_TIMER].base, memmap[IBEX_DEV_AON_TIMER].size); 281 create_unimplemented_device("riscv.lowrisc.ibex.usbdev", 282 memmap[IBEX_DEV_USBDEV].base, memmap[IBEX_DEV_USBDEV].size); 283 create_unimplemented_device("riscv.lowrisc.ibex.flash_ctrl", 284 memmap[IBEX_DEV_FLASH_CTRL].base, memmap[IBEX_DEV_FLASH_CTRL].size); 285 create_unimplemented_device("riscv.lowrisc.ibex.aes", 286 memmap[IBEX_DEV_AES].base, memmap[IBEX_DEV_AES].size); 287 create_unimplemented_device("riscv.lowrisc.ibex.hmac", 288 memmap[IBEX_DEV_HMAC].base, memmap[IBEX_DEV_HMAC].size); 289 create_unimplemented_device("riscv.lowrisc.ibex.kmac", 290 memmap[IBEX_DEV_KMAC].base, memmap[IBEX_DEV_KMAC].size); 291 create_unimplemented_device("riscv.lowrisc.ibex.keymgr", 292 memmap[IBEX_DEV_KEYMGR].base, memmap[IBEX_DEV_KEYMGR].size); 293 create_unimplemented_device("riscv.lowrisc.ibex.csrng", 294 memmap[IBEX_DEV_CSRNG].base, memmap[IBEX_DEV_CSRNG].size); 295 create_unimplemented_device("riscv.lowrisc.ibex.entropy", 296 memmap[IBEX_DEV_ENTROPY].base, memmap[IBEX_DEV_ENTROPY].size); 297 create_unimplemented_device("riscv.lowrisc.ibex.edn0", 298 memmap[IBEX_DEV_EDNO].base, memmap[IBEX_DEV_EDNO].size); 299 create_unimplemented_device("riscv.lowrisc.ibex.edn1", 300 memmap[IBEX_DEV_EDN1].base, memmap[IBEX_DEV_EDN1].size); 301 create_unimplemented_device("riscv.lowrisc.ibex.alert_handler", 302 memmap[IBEX_DEV_ALERT_HANDLER].base, memmap[IBEX_DEV_ALERT_HANDLER].size); 303 create_unimplemented_device("riscv.lowrisc.ibex.sram_ctrl", 304 memmap[IBEX_DEV_SRAM_CTRL].base, memmap[IBEX_DEV_SRAM_CTRL].size); 305 create_unimplemented_device("riscv.lowrisc.ibex.otbn", 306 memmap[IBEX_DEV_OTBN].base, memmap[IBEX_DEV_OTBN].size); 307 create_unimplemented_device("riscv.lowrisc.ibex.ibex_cfg", 308 memmap[IBEX_DEV_IBEX_CFG].base, memmap[IBEX_DEV_IBEX_CFG].size); 309 } 310 311 static const Property lowrisc_ibex_soc_props[] = { 312 DEFINE_PROP_UINT32("resetvec", LowRISCIbexSoCState, resetvec, 0x20000400), 313 }; 314 315 static void lowrisc_ibex_soc_class_init(ObjectClass *oc, void *data) 316 { 317 DeviceClass *dc = DEVICE_CLASS(oc); 318 319 device_class_set_props(dc, lowrisc_ibex_soc_props); 320 dc->realize = lowrisc_ibex_soc_realize; 321 /* Reason: Uses serial_hds in realize function, thus can't be used twice */ 322 dc->user_creatable = false; 323 } 324 325 static const TypeInfo open_titan_types[] = { 326 { 327 .name = TYPE_RISCV_IBEX_SOC, 328 .parent = TYPE_DEVICE, 329 .instance_size = sizeof(LowRISCIbexSoCState), 330 .instance_init = lowrisc_ibex_soc_init, 331 .class_init = lowrisc_ibex_soc_class_init, 332 }, { 333 .name = TYPE_OPENTITAN_MACHINE, 334 .parent = TYPE_MACHINE, 335 .instance_size = sizeof(OpenTitanState), 336 .class_init = opentitan_machine_class_init, 337 } 338 }; 339 340 DEFINE_TYPES(open_titan_types) 341