RISC-V Add the OpenTitan Machine
v6 cover RISC-V Add the OpenTitan Machine
OpenTitan is an open source silicon Root of Trust (RoT) project. This series adds initial support for the OpenTitan machine to QEMU.
This series add the Ibex CPU to the QEMU RISC-V target. It then adds the OpenTitan machine, the Ibex UART and the Ibex PLIC.
The UART has been tested sending and receiving data.
With this series QEMU can boot the OpenTitan ROM, Tock OS and a Tock userspace app.
The Ibex PLIC is similar to the RISC-V PLIC (and is based on the QEMU implementation) with some differences. The hope is that the Ibex PLIC will converge to follow the RISC-V spec. As that happens I want to update the QEMU Ibex PLIC and hopefully eventually replace the current PLIC as the implementation is a little overlay complex.
For more details on OpenTitan, see here: https://docs.opentitan.org/
v6:
- Rebase on master (some patches applied)
- Fix the ROM address
v5:
- Add some of the missing unimplemented devices
- Don't set PMP feature in init() function
v4:
- Don't set the reset vector in realise
- Fix a bug where the MMU is always enabled
- Fixup the PMP/MMU size logic
v3:
- Small fixes pointed out in review
v2:
- Rebase on master
- Get uart receive working
Alistair Francis (6):
riscv/opentitan: Fix the ROM size
hw/char: Initial commit of Ibex UART hw/intc: Initial commit of lowRISC Ibex PLIC riscv/opentitan: Connect the PLIC device riscv/opentitan: Connect the UART device target/riscv: Use a smaller guess size for no-MMU PMP
include/hw/char/ibex_uart.h | 110 ++++++++ include/hw/intc/ibex_plic.h | 63 +++++ include/hw/riscv/opentitan.h | 16 ++ hw/char/ibex_uart.c | 492 +++++++++++++++++++++++++++++++++++ hw/intc/ibex_plic.c | 261 +++++++++++++++++++ hw/riscv/opentitan.c | 45 +++- target/riscv/pmp.c | 14 +- MAINTAINERS | 4 + hw/char/Makefile.objs | 1 + hw/intc/Makefile.objs | 1 + hw/riscv/Kconfig | 4 + 11 files changed, 1001 insertions(+), 10 deletions(-) create mode 100644 include/hw/char/ibex_uart.h create mode 100644 include/hw/intc/ibex_plic.h create mode 100644 hw/char/ibex_uart.c create mode 100644 hw/intc/ibex_plic.c
Signature · 1 line
2.26.2
PATCH v6 1/6 riscv/opentitan: Fix the ROM size
--- hw/riscv/opentitan.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
hw/riscv/opentitan.c +1 -1
@@ -30,7 +30,7 @@ static const struct MemmapEntry {hwaddr base;hwaddr size; } ibex_memmap[] = { - [IBEX_ROM] = { 0x00008000, 0xc000 }, + [IBEX_ROM] = { 0x00008000, 16 * KiB }, [IBEX_RAM] = { 0x10000000, 0x10000 }, [IBEX_FLASH] = { 0x20000000, 0x80000 }, [IBEX_UART] = { 0x40000000, 0x10000 },
Signature · 1 line
2.26.2
PATCH v6 2/6 hw/char: Initial commit of Ibex UART
In reply to Alistair FrancisThis is the initial commit of the Ibex UART device. Serial TX is working, while RX has been implemeneted but untested.
This is based on the documentation from:
https://docs.opentitan.org/hw/ip/uart/doc/
--- include/hw/char/ibex_uart.h | 110 ++++++++ hw/char/ibex_uart.c | 492 ++++++++++++++++++++++++++++++++++++ MAINTAINERS | 2 + hw/char/Makefile.objs | 1 + hw/riscv/Kconfig | 4 + 5 files changed, 609 insertions(+) create mode 100644 include/hw/char/ibex_uart.h create mode 100644 hw/char/ibex_uart.c
include/hw/char/ibex_uart.h new file +110 -0
@@ -0,0 +1,110 @@ +/* +* QEMU lowRISC Ibex UART device +* +* Copyright (c) 2020 Western Digital +* +* Permission is hereby granted, free of charge, to any person obtaining a copy +* of this software and associated documentation files (the "Software"), to deal +* in the Software without restriction, including without limitation the rights +* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +* copies of the Software, and to permit persons to whom the Software is +* furnished to do so, subject to the following conditions: +* +* The above copyright notice and this permission notice shall be included in +* all copies or substantial portions of the Software. +* +* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +* THE SOFTWARE. +*/ + +#ifndef HW_IBEX_UART_H +#define HW_IBEX_UART_H + +#include "hw/sysbus.h" +#include "chardev/char-fe.h" +#include "qemu/timer.h" + +#define IBEX_UART_INTR_STATE 0x00 +#define INTR_STATE_TX_WATERMARK (1 << 0) +#define INTR_STATE_RX_WATERMARK (1 << 1) +#define INTR_STATE_TX_EMPTY (1 << 2) +#define INTR_STATE_RX_OVERFLOW (1 << 3) +#define IBEX_UART_INTR_ENABLE 0x04 +#define IBEX_UART_INTR_TEST 0x08 + +#define IBEX_UART_CTRL 0x0c +#define UART_CTRL_TX_ENABLE (1 << 0) +#define UART_CTRL_RX_ENABLE (1 << 1) +#define UART_CTRL_NF (1 << 2) +#define UART_CTRL_SLPBK (1 << 4) +#define UART_CTRL_LLPBK (1 << 5) +#define UART_CTRL_PARITY_EN (1 << 6) +#define UART_CTRL_PARITY_ODD (1 << 7) +#define UART_CTRL_RXBLVL (3 << 8) +#define UART_CTRL_NCO (0xFFFF << 16) + +#define IBEX_UART_STATUS 0x10 +#define UART_STATUS_TXFULL (1 << 0) +#define UART_STATUS_RXFULL (1 << 1) +#define UART_STATUS_TXEMPTY (1 << 2) +#define UART_STATUS_RXIDLE (1 << 4) +#define UART_STATUS_RXEMPTY (1 << 5) + +#define IBEX_UART_RDATA 0x14 +#define IBEX_UART_WDATA 0x18 + +#define IBEX_UART_FIFO_CTRL 0x1c +#define FIFO_CTRL_RXRST (1 << 0) +#define FIFO_CTRL_TXRST (1 << 1) +#define FIFO_CTRL_RXILVL (7 << 2) +#define FIFO_CTRL_RXILVL_SHIFT (2) +#define FIFO_CTRL_TXILVL (3 << 5) +#define FIFO_CTRL_TXILVL_SHIFT (5) + +#define IBEX_UART_FIFO_STATUS 0x20 +#define IBEX_UART_OVRD 0x24 +#define IBEX_UART_VAL 0x28 +#define IBEX_UART_TIMEOUT_CTRL 0x2c + +#define IBEX_UART_TX_FIFO_SIZE 16 + +#define TYPE_IBEX_UART "ibex-uart" +#define IBEX_UART (obj) \ + OBJECT_CHECK(IbexUartState, (obj), TYPE_IBEX_UART) + +typedef struct { +/* <private> */ +SysBusDevice parent_obj; + +/* <public> */ +MemoryRegion mmio; + +uint8_t tx_fifo[IBEX_UART_TX_FIFO_SIZE ]; +uint32_t tx_level; + +QEMUTimer *fifo_trigger_handle; +uint64_t char_tx_time; + +uint32_t uart_intr_state; +uint32_t uart_intr_enable; +uint32_t uart_ctrl; +uint32_t uart_status; +uint32_t uart_rdata; +uint32_t uart_fifo_ctrl; +uint32_t uart_fifo_status; +uint32_t uart_ovrd; +uint32_t uart_val; +uint32_t uart_timeout_ctrl; + +CharBackend chr; +qemu_irq tx_watermark; +qemu_irq rx_watermark; +qemu_irq tx_empty; +qemu_irq rx_overflow; +}IbexUartState ; +#endif /* HW_IBEX_UART_H */
hw/char/ibex_uart.c new file +492 -0
492 lines not on this page · raw message
MAINTAINERS +2 -0
@@ -1246,7 +1246,9 @@ M: Alistair Francis <[email protected]> L: [email protected] S: Supported F: hw/riscv/opentitan.c +F: hw/char/ibex_uart.c F: include/hw/riscv/opentitan.h +F: include/hw/char/ibex_uart.h SH4 Machines ------------
hw/char/Makefile.objs +1 -0
@@ -12,6 +12,7 @@ common-obj-$(CONFIG_VIRTIO_SERIAL) += virtio-console.o common-obj-$(CONFIG_XILINX) += xilinx_uartlite.o common-obj-$(CONFIG_XEN) += xen_console.o common-obj-$(CONFIG_CADENCE) += cadence_uart.o +common-obj-$(CONFIG_IBEX) += ibex_uart.o common-obj-$(CONFIG_EXYNOS4) += exynos4210_uart.o common-obj-$(CONFIG_COLDFIRE) += mcf_uart.o
hw/riscv/Kconfig +4 -0
@@ -4,6 +4,9 @@ config HTIF config HART bool +config IBEX + bool + config SIFIVE bool select MSI_NONBROKEN
@@ -29,6 +32,7 @@ config SPIKE config OPENTITAN bool + select IBEX select HART select UNIMP
Signature · 1 line
2.26.2
PATCH v6 3/6 hw/intc: Initial commit of lowRISC Ibex PLIC
In reply to Alistair FrancisThe Ibex core contains a PLIC that although similar to the RISC-V spec is not RISC-V spec compliant.
This patch implements a Ibex PLIC in a somewhat generic way.
As the current RISC-V PLIC needs tidying up, my hope is that as the Ibex PLIC move towards spec compliance this PLIC implementation can be updated until it can replace the current PLIC.
--- include/hw/intc/ibex_plic.h | 63 +++++++++ hw/intc/ibex_plic.c | 261 ++++++++++++++++++++++++++++++++++++ MAINTAINERS | 2 + hw/intc/Makefile.objs | 1 + 4 files changed, 327 insertions(+) create mode 100644 include/hw/intc/ibex_plic.h create mode 100644 hw/intc/ibex_plic.c
include/hw/intc/ibex_plic.h new file +63 -0
@@ -0,0 +1,63 @@ +/* +* QEMU RISC-V lowRISC Ibex PLIC +* +* Copyright (c) 2020 Western Digital +* +* This program is free software; you can redistribute it and/or modify it +* under the terms and conditions of the GNU General Public License, +* version 2 or later, as published by the Free Software Foundation. +* +* This program is distributed in the hope it will be useful, but WITHOUT +* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +* more details. +* +* You should have received a copy of the GNU General Public License along with +* this program. If not, see <http://www.gnu.org/licenses/>. +*/ + +#ifndef HW_IBEX_PLIC_H +#define HW_IBEX_PLIC_H + +#include "hw/sysbus.h" + +#define TYPE_IBEX_PLIC "ibex-plic" +#define IBEX_PLIC (obj) \ + OBJECT_CHECK(IbexPlicState, (obj), TYPE_IBEX_PLIC) + +typedef struct IbexPlicState { +/*< private >*/ +SysBusDevice parent_obj; + +/*< public >*/ +MemoryRegion mmio; + +uint32_t *pending; +uint32_t *source; +uint32_t *priority; +uint32_t *enable; +uint32_t threshold; +uint32_t claim; + +/* config */ +uint32_t num_cpus; +uint32_t num_sources; + +uint32_t pending_base; +uint32_t pending_num; + +uint32_t source_base; +uint32_t source_num; + +uint32_t priority_base; +uint32_t priority_num; + +uint32_t enable_base; +uint32_t enable_num; + +uint32_t threshold_base; + +uint32_t claim_base; +}IbexPlicState ; + +#endif /* HW_IBEX_PLIC_H */
hw/intc/ibex_plic.c new file +261 -0
261 lines not on this page · raw message
MAINTAINERS +2 -0
@@ -1247,8 +1247,10 @@ L: [email protected] S: Supported F: hw/riscv/opentitan.c F: hw/char/ibex_uart.c +F: hw/intc/ibex_plic.c F: include/hw/riscv/opentitan.h F: include/hw/char/ibex_uart.h +F: include/hw/intc/ibex_plic.h SH4 Machines ------------
hw/intc/Makefile.objs +1 -0
@@ -49,3 +49,4 @@ obj-$(CONFIG_ARM_GIC) += arm_gicv3_cpuif.o obj-$(CONFIG_MIPS_CPS) += mips_gic.o obj-$(CONFIG_NIOS2) += nios2_iic.o obj-$(CONFIG_OMPIC) += ompic.o +obj-$(CONFIG_IBEX) += ibex_plic.o
Signature · 1 line
2.26.2
PATCH v6 4/6 riscv/opentitan: Connect the PLIC device
In reply to Alistair Francis--- include/hw/riscv/opentitan.h | 3 +++ hw/riscv/opentitan.c | 19 +++++++++++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-)
include/hw/riscv/opentitan.h +3 -0
@@ -20,6 +20,7 @@#define HW_OPENTITAN_H #include "hw/riscv/riscv_hart.h" +#include "hw/intc/ibex_plic.h" #define TYPE_RISCV_IBEX_SOC "riscv.lowrisc.ibex.soc"#define RISCV_IBEX_SOC (obj) \
@@ -31,6 +32,8 @@ typedef struct LowRISCIbexSoCState {/*< public >*/ RISCVHartArrayState cpus; +IbexPlicState plic; +MemoryRegion flash_mem;MemoryRegion rom; } LowRISCIbexSoCState;
hw/riscv/opentitan.c +17 -2
@@ -25,6 +25,7 @@#include "hw/misc/unimp.h" #include "hw/riscv/boot.h" #include "exec/address-spaces.h" +#include "sysemu/sysemu.h" static const struct MemmapEntry { hwaddr base;
@@ -97,6 +98,9 @@ static void riscv_lowrisc_ibex_soc_init(Object *obj)object_initialize_child (obj,"cpus" , &s->cpus,sizeof (s->cpus),TYPE_RISCV_HART_ARRAY , &error_abort,NULL ); + +sysbus_init_child_obj (obj,"plic" , &s->plic, +sizeof (s->plic),TYPE_IBEX_PLIC ); }static void riscv_lowrisc_ibex_soc_realize (DeviceState *dev_soc,Error **errp)
@@ -105,6 +109,9 @@ static void riscv_lowrisc_ibex_soc_realize(DeviceState *dev_soc, Error **errp)MachineState *ms =MACHINE (qdev_get_machine ());LowRISCIbexSoCState *s =RISCV_IBEX_SOC (dev_soc);MemoryRegion *sys_mem =get_system_memory (); +DeviceState *dev; +SysBusDevice *busdev; +Error *err =NULL ;object_property_set_str (OBJECT (&s->cpus), ms->cpu_type,"cpu-type" , &error_abort);
@@ -125,6 +132,16 @@ static void riscv_lowrisc_ibex_soc_realize(DeviceState *dev_soc, Error **errp)memory_region_add_subregion (sys_mem, memmap[IBEX_FLASH ].base, &s->flash_mem); +/* PLIC */ + dev =DEVICE (&s->plic); +object_property_set_bool (OBJECT (&s->plic), true,"realized" , &err); +if (err !=NULL ) { +error_propagate (errp, err); +return ; + } + busdev =SYS_BUS_DEVICE (dev); +sysbus_mmio_map (busdev,0 , memmap[IBEX_PLIC ].base); +create_unimplemented_device ("riscv.lowrisc.ibex.uart" , memmap[IBEX_UART ].base, memmap[IBEX_UART ].size); create_unimplemented_device("riscv.lowrisc.ibex.gpio",
@@ -145,8 +162,6 @@ static void riscv_lowrisc_ibex_soc_realize(DeviceState *dev_soc, Error **errp) memmap[IBEX_AES].base, memmap[IBEX_AES].size);create_unimplemented_device ("riscv.lowrisc.ibex.hmac" , memmap[IBEX_HMAC ].base, memmap[IBEX_HMAC ].size); -create_unimplemented_device ("riscv.lowrisc.ibex.plic" , - memmap[IBEX_PLIC ].base, memmap[IBEX_PLIC ].size);create_unimplemented_device ("riscv.lowrisc.ibex.pinmux" , memmap[IBEX_PINMUX ].base, memmap[IBEX_PINMUX ].size); create_unimplemented_device("riscv.lowrisc.ibex.alert_handler",
Signature · 1 line
2.26.2
PATCH v6 5/6 riscv/opentitan: Connect the UART device
In reply to Alistair Francis--- include/hw/riscv/opentitan.h | 13 +++++++++++++ hw/riscv/opentitan.c | 24 ++++++++++++++++++++++-- 2 files changed, 35 insertions(+), 2 deletions(-)
include/hw/riscv/opentitan.h +13 -0
@@ -21,6 +21,7 @@#include "hw/riscv/riscv_hart.h" #include "hw/intc/ibex_plic.h" +#include "hw/char/ibex_uart.h" #define TYPE_RISCV_IBEX_SOC "riscv.lowrisc.ibex.soc"#define RISCV_IBEX_SOC (obj) \
@@ -33,6 +34,7 @@ typedef struct LowRISCIbexSoCState {/*< public >*/ RISCVHartArrayState cpus;IbexPlicState plic; +IbexUartState uart;MemoryRegion flash_mem;MemoryRegion rom;
@@ -68,4 +70,15 @@ enum { IBEX_PADCTRL, }; +enum { +IBEX_UART_RX_PARITY_ERR_IRQ =0x28 , +IBEX_UART_RX_TIMEOUT_IRQ =0x27 , +IBEX_UART_RX_BREAK_ERR_IRQ =0x26 , +IBEX_UART_RX_FRAME_ERR_IRQ =0x25 , +IBEX_UART_RX_OVERFLOW_IRQ =0x24 , +IBEX_UART_TX_EMPTY_IRQ =0x23 , +IBEX_UART_RX_WATERMARK_IRQ =0x22 , +IBEX_UART_TX_WATERMARK_IRQ =0x21 , +}; +#endif
hw/riscv/opentitan.c +22 -2
@@ -101,6 +101,9 @@ static void riscv_lowrisc_ibex_soc_init(Object *obj)sysbus_init_child_obj (obj,"plic" , &s->plic,sizeof (s->plic),TYPE_IBEX_PLIC ); + +sysbus_init_child_obj (obj,"uart" , &s->uart, +sizeof (s->uart),TYPE_IBEX_UART ); }static void riscv_lowrisc_ibex_soc_realize (DeviceState *dev_soc,Error **errp)
@@ -142,8 +145,25 @@ static void riscv_lowrisc_ibex_soc_realize(DeviceState *dev_soc, Error **errp) busdev =SYS_BUS_DEVICE (dev);sysbus_mmio_map (busdev,0 , memmap[IBEX_PLIC ].base); -create_unimplemented_device ("riscv.lowrisc.ibex.uart" , - memmap[IBEX_UART ].base, memmap[IBEX_UART ].size); +/* UART */ + dev =DEVICE (&(s->uart)); +qdev_prop_set_chr (dev,"chardev" ,serial_hd (0 )); +object_property_set_bool (OBJECT (&s->uart), true,"realized" , &err); +if (err !=NULL ) { +error_propagate (errp, err); +return ; + } + busdev =SYS_BUS_DEVICE (dev); +sysbus_mmio_map (busdev,0 , memmap[IBEX_UART ].base); +sysbus_connect_irq (busdev,0 ,qdev_get_gpio_in (DEVICE (&s->plic), +IBEX_UART_TX_WATERMARK_IRQ )); +sysbus_connect_irq (busdev,1 ,qdev_get_gpio_in (DEVICE (&s->plic), +IBEX_UART_RX_WATERMARK_IRQ )); +sysbus_connect_irq (busdev,2 ,qdev_get_gpio_in (DEVICE (&s->plic), +IBEX_UART_TX_EMPTY_IRQ )); +sysbus_connect_irq (busdev,3 ,qdev_get_gpio_in (DEVICE (&s->plic), +IBEX_UART_RX_OVERFLOW_IRQ )); +create_unimplemented_device ("riscv.lowrisc.ibex.gpio" , memmap[IBEX_GPIO ].base, memmap[IBEX_GPIO ].size); create_unimplemented_device("riscv.lowrisc.ibex.spi",
Signature · 1 line
2.26.2
PATCH v6 6/6 target/riscv: Use a smaller guess size for no-MMU PMP
In reply to Alistair Francis--- target/riscv/pmp.c | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-)
target/riscv/pmp.c +9 -5
@@ -233,12 +233,16 @@ bool pmp_hart_has_privs(CPURISCVState *env, target_ulong addr,return true; } -/* -* if size is unknown (0), assume that all bytes -* from addr to the end of the page will be accessed. -*/ if (size ==0 ) { - pmp_size = -(addr |TARGET_PAGE_MASK ); +if (riscv_feature (env,RISCV_FEATURE_MMU )) { +/* +* If size is unknown (0), assume that all bytes +* from addr to the end of the page will be accessed. +*/ + pmp_size = -(addr |TARGET_PAGE_MASK ); + }else { + pmp_size =sizeof (target_ulong); + } }else { pmp_size = size; }
Signature · 1 line
2.26.2