riscv: support qemu-riscv-virt platform

Signed-off-by: Axel Heider <[email protected]>

CHANGES

@@ -30,6 +30,7 @@ Upcoming release: BREAKING
  * Added support for the ODroid C4
  * Added support for the Avnet MaaXBoard
  * Added support for arm_hyp on qemu-arm-virt platfrom with cortex-a15 CPU
+ * Added support for qemu-riscv-virt
  * Rename libsel4 config option ENABLE_SMP_SUPPORT to CONFIG_ENABLE_SMP_SUPPORT to be namespace compliant.
  * Rename libsel4 config option AARCH64_VSPACE_S2_START_L1 to CONFIG_AARCH64_VSPACE_S2_START_L1 to be namespace
    compliant.

include/drivers/irq/riscv_plic0.h

@@ -4,15 +4,18 @@
  *
  * SPDX-License-Identifier: GPL-2.0-only
  *
- * SiFive U54/U74 PLIC handling (HiFive Unleashed/Unmatched, Polarfire)
+ * SiFive U54/U74 PLIC handling (HiFive Unleashed/Unmatched, Polarfire,
+ * QEMU RISC-V virt)
  */
 
 #pragma once
 
 /* This is a check that prevents using this driver blindly. Extend the list if
  * this driver is confirmed to be working on other platforms. */
-#if !defined(CONFIG_PLAT_HIFIVE) && !defined(CONFIG_PLAT_POLARFIRE)
-#error "This code supports the SiFive U54/U74 PLIC only."
+#if !defined(CONFIG_PLAT_HIFIVE) && \
+    !defined(CONFIG_PLAT_POLARFIRE) && \
+    !defined(CONFIG_PLAT_QEMU_RISCV_VIRT)
+#error "Check if this platform suppots a PLIC."
 #endif
 
 /* tell the kernel we have the set trigger feature */

libsel4/sel4_plat_include/qemu-riscv-virt/sel4/plat/api/constants.h

@@ -0,0 +1,11 @@
+/*
+ * Copyright 2022, HENSOLDT Cyber
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <autoconf.h>
+
+/* nothing here */

src/plat/qemu-riscv-virt/config.cmake

@@ -0,0 +1,188 @@
+#
+# Copyright 2022, HENSOLDT Cyber
+# Copyright 2020, Data61, CSIRO (ABN 41 687 119 230)
+#
+# SPDX-License-Identifier: GPL-2.0-only
+#
+
+cmake_minimum_required(VERSION 3.7.2)
+
+declare_platform(qemu-riscv-virt KernelPlatformQEMURiscVVirt PLAT_QEMU_RISCV_VIRT KernelArchRiscV)
+
+if(KernelPlatformQEMURiscVVirt)
+
+    if("${KernelSel4Arch}" STREQUAL riscv64)
+        declare_seL4_arch(riscv64)
+    elseif("${KernelSel4Arch}" STREQUAL riscv32)
+        declare_seL4_arch(riscv32) # This is still untested
+    else()
+        fallback_declare_seL4_arch_default(riscv64)
+    endif()
+
+    config_set(KernelOpenSBIPlatform OPENSBI_PLATFORM "generic")
+    config_set(KernelPlatformFirstHartID FIRST_HART_ID 0)
+
+    # If neither QEMU_DTS nor QEMU_DTB is set explicitly, the device tree is
+    # extracted from QEMU. This keeps it nicely up to date with the the actual
+    # QEMU versions that is used, and it's quite convenient for development.
+    if(NOT DEFINED QEMU_DTS)
+
+        set(QEMU_DTS "${CMAKE_BINARY_DIR}/qemu-riscv-virt.dts")
+
+        if(NOT DEFINED QEMU_DTB)
+
+            message(STATUS "Extracting device tree from QEMU")
+            set(QEMU_DTB "${CMAKE_BINARY_DIR}/qemu-riscv-virt.dtb")
+
+            # Use the system's QEMU if no custom QEMU is provided. Have a sanity
+            # check about the version to ensure it can be used.
+            if(NOT QEMU_BINARY)
+                set(QEMU_BINARY "qemu-system-${KernelSel4Arch}")
+                find_program(QEMU_BINARY ${QEMU_BINARY})
+                # RISC-V virtual platform works since QEMU v5.1.0
+                set(MIN_QEMU_VERSION "5.1.0")
+                execute_process(
+                    COMMAND ${QEMU_BINARY} -version
+                    RESULT_VARIABLE error
+                    OUTPUT_STRIP_TRAILING_WHITESPACE
+                    OUTPUT_VARIABLE QEMU_STDOUT_MESSAGE
+                )
+                if(error)
+                    message(FATAL_ERROR "Failed to determine QEMU version (${QEMU_BINARY})")
+                endif()
+                string(
+                    REGEX
+                        MATCH
+                        "[0-9](\\.[0-9])+"
+                        QEMU_VERSION
+                        "${QEMU_STDOUT_MESSAGE}"
+                )
+                if("${QEMU_VERSION}" VERSION_LESS "${MIN_QEMU_VERSION}")
+                    message(
+                        FATAL_ERROR
+                            "Error: need at least QEMU version ${MIN_QEMU_VERSION}, found '${QEMU_VERSION}'"
+                    )
+                endif()
+
+            endif()
+
+            if(NOT DEFINED QEMU_MACHINE)
+                set(QEMU_MACHINE "virt")
+                #list(APPEND QEMU_MACHINE "aclint=off")   # on/off
+                #list(APPEND QEMU_MACHINE "aia=none")     # none/aplic/aplic-imsic
+                #list(APPEND QEMU_MACHINE "aia-guests=0") # VS-level AIA IMSIC pages per hart
+                list(APPEND QEMU_MACHINE "dumpdtb=${QEMU_DTB}")
+
+                # Lists are just strings with ";" as item separator, so we can
+                # just replace them by ",". The cleaner way would be using the
+                # CMake 3.12 feature: list(JOIN QEMU_MACHINE "," QEMU_MACHINE)
+                string(
+                    REPLACE
+                        ";"
+                        ","
+                        QEMU_MACHINE
+                        "${QEMU_MACHINE}"
+                )
+            endif()
+
+            if(NOT DEFINED QEMU_CPU)
+                set(QEMU_CPU "rv${KernelWordSize}")
+            endif()
+
+            if(NOT DEFINED QEMU_MEMORY)
+                # Having 3 GiB of memory as default seems a good trade-off. It's
+                # sufficient for test/demo systems, but still something the host
+                # can provide without running short on resources.
+                set(QEMU_MEMORY "3072")
+            endif()
+
+            if(KernelMaxNumNodes)
+                set(QEMU_SMP_OPTION "${KernelMaxNumNodes}")
+            else()
+                set(QEMU_SMP_OPTION "1")
+            endif()
+
+            # Run QEMU to get the device tree binary. Remember the command, so
+            # it can be added to the DTS as reference. Every parameter must be
+            # a separate string, as CMake will make it a dedicated argument
+            # passed to QEMU then (e.g. "-machine virt" wont be recognized,
+            # but "-machine", "vir" is).
+            set(
+                QEMU_CMD
+                "${QEMU_BINARY}"
+                "-machine"
+                "${QEMU_MACHINE}"
+                "-cpu"
+                "${QEMU_CPU}"
+                "-smp"
+                "${QEMU_SMP_OPTION}"
+                "-m"
+                "${QEMU_MEMORY}"
+                "-nographic"
+            )
+            # When dumping the DTB to a file, QEMU prints a status message to
+            # stderr. Capture it and print on stdout to avoid polluting stderr
+            # unnecessarily.
+            execute_process(
+                COMMAND ${QEMU_CMD}
+                RESULT_VARIABLE error
+                ERROR_STRIP_TRAILING_WHITESPACE
+                ERROR_VARIABLE QEMU_STDERR_MESSAGE
+            )
+            if(QEMU_STDERR_MESSAGE)
+                message(STATUS "${QEMU_STDERR_MESSAGE}")
+            endif()
+            if(error)
+                message(FATAL_ERROR "Failed to dump DTB using ${QEMU_BINARY}: ${error}")
+            endif()
+
+        endif()
+
+        # At this point there is a DTB file, either it was passed or dumped from
+        # QEMU. Create a DTS and store it in QEMU_DTS_DATA.
+        execute_process(
+            COMMAND
+                dtc -q -I dtb -O dts "${QEMU_DTB}"
+            OUTPUT_VARIABLE QEMU_DTS_DATA
+            RESULT_VARIABLE error
+        )
+        if(error)
+            message(FATAL_ERROR "Failed to create DTS from QEMU's DTB ${QEMU_DTB}: ${error}")
+        endif()
+
+        set(QEMU_DTS_INFO "converted from ${QEMU_DTB}")
+        if(QEMU_CMD)
+            # Lists are just strings with ";" as item separator, so we can
+            # simply replace them with something else. The cleaner way is a
+            # CMake 3.12 feature: list(JOIN QEMU_CMD "\n *    " QEMU_DTS_INFO)
+            string(
+                REPLACE
+                    ";"
+                    "\n *    "
+                    QEMU_DTS_INFO
+                    "DTS of QEMU v${QEMU_VERSION} for:;${QEMU_CMD}"
+            )
+        endif()
+        file(
+            WRITE
+                "${QEMU_DTS}"
+                "/*\n"
+                " * ${QEMU_DTS_INFO}\n"
+                " */\n"
+                "\n"
+                "${QEMU_DTS_DATA}"
+        )
+
+    endif()
+
+    list(APPEND KernelDTSList "${QEMU_DTS}" "${CMAKE_CURRENT_LIST_DIR}/overlay-qemu-riscv-virt.dts")
+
+    # QEMU emulates a SiFive PLIC/CLINT with 127 interrupt sources by default.
+    # The CLINT timer pretends to run at 10 MHz, but this speed may not hold in
+    # practical measurements.
+    declare_default_headers(
+        TIMER_FREQUENCY 10000000 PLIC_MAX_NUM_INT 128
+        INTERRUPT_CONTROLLER drivers/irq/riscv_plic0.h
+    )
+
+endif()

src/plat/qemu-riscv-virt/overlay-qemu-riscv-virt.dts

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2022, HENSOLDT Cyber
+ *
+ * SPDX-License-Identifier: GPL-2.0-only
+ */
+
+/ {
+    chosen {
+        /*
+         * - elfloader and kernel use SBI console by default
+         * - QEMU emulates a SiFive PLIC and CLINT by default
+         *
+         * Nothing needed for elfloader
+         *      seL4,elfloader-devices = ... ;
+         *
+         */
+        seL4,kernel-devices =
+            &{/soc/plic@c000000};
+    };
+};