[rom_ctrl, test] rom_ctrl smoketest added

 * new testcase implemented among top level sw tests
 * the new test reads the compile time initialized ROM values
 * if any comparision fails (expected values differs from read value)
   test is terminated with an error
 * sw test files reformated to compplie with clang format

Author: KolosKoblasz-Semify

hw/top_chip/dv/top_chip_sim_cfg.hjson

@@ -176,6 +176,12 @@
       sw_images: ["mailbox_smoketest_cheri_bare:5"]
       run_opts: ["+ChipMemSRAM_image_file={run_dir}/mailbox_smoketest_cheri_bare.vmem"]
     }
+    {
+      name: rom_ctrl_smoke
+      uvm_test_seq: top_chip_dv_uart_base_vseq
+      sw_images: ["rom_ctrl_smoketest_vanilla_bare:5"]
+      run_opts: ["+ChipMemSRAM_image_file={run_dir}/rom_ctrl_smoketest_vanilla_bare.vmem"]
+    }
   ]
 
   // List of regressions.
@@ -199,6 +205,7 @@
         "mailbox_smoke",
         //TODO currently broken.
         // "mailbox_smoke_cheri"
+        "rom_ctrl_smoke"
       ]
     }
     {
@@ -254,7 +261,8 @@
     {
       name: rom_ctrl
       tests: [
-        "rom_ctrl_integrity_check"
+        "rom_ctrl_integrity_check",
+        "rom_ctrl_smoke"
       ]
     }
     {

sw/device/lib/hal/CMakeLists.txt

@@ -2,6 +2,6 @@
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
 
-set(SRCS clkmgr.c gpio.c i2c.c mailbox.c mocha.c plic.c rstmgr.c spi_device.c timer.c uart.c)
+set(SRCS clkmgr.c gpio.c i2c.c mailbox.c mocha.c plic.c rstmgr.c spi_device.c timer.c uart.c rom_ctrl.c)
 
 mocha_add_library(NAME hal LIBRARIES SOURCES ${SRCS})

sw/device/lib/hal/mocha.c

@@ -11,11 +11,13 @@
 #include <cheriintrin.h>
 #endif /* defined(__riscv_zcherihybrid) */
 
+static const uintptr_t rom_base = 0x80000ul;
 static const uintptr_t mailbox_base = 0x20010000ul;
 static const uintptr_t dv_test_status_base = 0x20020000ul;
 static const uintptr_t gpio_base = 0x40000000ul;
 static const uintptr_t clkmgr_base = 0x40020000ul;
 static const uintptr_t rstmgr_base = 0x40030000ul;
+static const uintptr_t rom_ctrl_base = 0x40050000ul;
 static const uintptr_t uart_base = 0x41000000ul;
 static const uintptr_t i2c_base = 0x42000000ul;
 static const uintptr_t spi_device_base = 0x43000000ul;
@@ -42,6 +44,15 @@ static void *create_mmio_capability(uintptr_t address, size_t length)
 }
 #endif /* defined(__riscv_zcherihybrid) */
 
+rom_t mocha_system_rom(void)
+{
+#if defined(__riscv_zcherihybrid)
+    return (rom_t)create_mmio_capability(rom_base, 0x8000u);
+#else /* !defined(__riscv_zcherihybrid) */
+    return (rom_t)rom_base;
+#endif /* defined(__riscv_zcherihybrid) */
+}
+
 mailbox_t mocha_system_mailbox(void)
 {
 #if defined(__riscv_zcherihybrid)
@@ -78,6 +89,15 @@ rstmgr_t mocha_system_rstmgr(void)
 #endif /* defined(__riscv_zcherihybrid) */
 }
 
+rom_ctrl_t mocha_system_rom_ctrl(void)
+{
+#if defined(__riscv_zcherihybrid)
+    return (rom_ctrl_t)create_mmio_capability(rom_ctrl_base, 0x48u);
+#else /* !defined(__riscv_zcherihybrid) */
+    return (rom_ctrl_t)rom_ctrl_base;
+#endif /* defined(__riscv_zcherihybrid) */
+}
+
 uart_t mocha_system_uart(void)
 {
 #if defined(__riscv_zcherihybrid)

sw/device/lib/hal/mocha.h

@@ -11,6 +11,7 @@
 #include "hal/i2c.h"
 #include "hal/mailbox.h"
 #include "hal/plic.h"
+#include "hal/rom_ctrl.h"
 #include "hal/rstmgr.h"
 #include "hal/spi_device.h"
 #include "hal/timer.h"
@@ -29,6 +30,8 @@ gpio_t mocha_system_gpio(void);
 clkmgr_t mocha_system_clkmgr(void);
 rstmgr_t mocha_system_rstmgr(void);
 uart_t mocha_system_uart(void);
+rom_t mocha_system_rom(void);
+rom_ctrl_t mocha_system_rom_ctrl(void);
 i2c_t mocha_system_i2c(void);
 spi_device_t mocha_system_spi_device(void);
 timer_t mocha_system_timer(void);

sw/device/lib/hal/rom_ctrl.c

@@ -0,0 +1,14 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "hal/rom_ctrl.h"
+#include "hal/mmio.h"
+#include "hal/mocha.h"
+#include <stdint.h>
+
+/* Read specific word_idx-th word from ROM memory */
+uint32_t read_rom(rom_t rom, uint32_t rel_addr)
+{
+    return DEV_READ(rom + rel_addr);
+}

sw/device/lib/hal/rom_ctrl.h

@@ -0,0 +1,19 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#define ROM_CTRL_REG      (0x0)
+#define FATAL_ALERT_CAUSE (0x4)
+
+typedef void *rom_ctrl_t;
+typedef void *rom_t;
+
+#define ROM_CTRL_FROM_BASE_ADDR(addr) ((rom_ctrl_t)(addr))
+#define ROM_FROM_BASE_ADDR(addr)      ((rom_t)(addr))
+
+uint32_t read_rom(rom_t rom, uint32_t rel_addr);

sw/device/tests/CMakeLists.txt

@@ -18,3 +18,4 @@ mocha_add_test(NAME tag_controller_tag_test SOURCES tag_controller/tag_test.c LI
 mocha_add_test(NAME timer_smoketest SOURCES timer/smoketest.c LIBRARIES ${LIBS} FPGA)
 mocha_add_test(NAME timer_interrupt_test SOURCES timer/interrupt.c LIBRARIES ${LIBS})
 mocha_add_test(NAME uart_smoketest SOURCES uart/smoketest.c LIBRARIES ${LIBS})
+mocha_add_test(NAME rom_ctrl_smoketest SOURCES rom_ctrl/smoketest.c LIBRARIES ${LIBS})

sw/device/tests/rom_ctrl/mem_init_file.vmem

@@ -0,0 +1,19 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+@00000000
+DEADBEEF
+CAFEBABE
+00000001
+EEEEEEEE
+@00001000
+01234567
+10000001
+20000002
+30000003
+@00001FFC
+F000000F
+0EEEEEE0
+0FFFFFF0
+01010101

sw/device/tests/rom_ctrl/smoketest.c

@@ -0,0 +1,62 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+#include "hal/mmio.h"
+#include "hal/mocha.h"
+#include "hal/rom_ctrl.h"
+#include "hal/uart.h"
+#include "runtime/print.h"
+#include <stdbool.h>
+#include <stdint.h>
+
+// Check ROM init values
+static bool rom_read_test(rom_t rom, uart_t console)
+{
+    uint32_t data;
+    uint32_t address;
+    uint8_t address_length = 3;
+    uint8_t data_length = 4;
+
+    // ROM Address values
+    const uint32_t expected_addresses[3] = { 0x00000000, 0x00004000, 0x00007FF0 };
+
+    // ROM Init values
+    const uint32_t expected_data[3][4] = { { 0xDEADBEEF, 0xCAFEBABE, 0x00000001, 0xEEEEEEEE },
+                                           { 0x01234567, 0x10000001, 0x20000002, 0x30000003 },
+                                           { 0xF000000F, 0x0EEEEEE0, 0x0FFFFFF0, 0x01010101 } };
+
+    uprintf(console, "\nRead ROM!\n");
+
+    // Reading and comparing
+    for (uint8_t address_idx = 0; address_idx < address_length; address_idx++) {
+        for (uint8_t word_idx = 0; word_idx < data_length; word_idx++) {
+            address = 4 * word_idx + expected_addresses[address_idx];
+            data = read_rom(rom, address);
+            uprintf(console, "[%lx] | ", (unsigned long)(uintptr_t)(rom + address));
+            uprintf(console, "0x%x \n", data);
+
+            if (expected_data[address_idx][word_idx] != data) {
+                uprintf(console, "Expected: 0x%x\n", expected_data[address_idx][word_idx]);
+                uprintf(console, "ROM Content mismatch Error. Terminating ROM CTRL read test\n");
+
+                return false;
+            }
+        }
+    }
+
+    return true;
+}
+
+bool test_main()
+{
+    rom_t rom = mocha_system_rom();
+    uart_t console = mocha_system_uart();
+    bool read_test_res;
+
+    uart_init(console);
+
+    read_test_res = rom_read_test(rom, console);
+
+    return read_test_res;
+}