sw: create DV register layout in HAL, adding hw_id

Co-authored-by: martin-velay <mvelay@lowrisc.org>
Signed-off-by: Alice Ziuziakowska <a.ziuziakowska@lowrisc.org>

Author: ziuziakowska

sw/device/lib/hal/dv.h

@@ -0,0 +1,47 @@
+// Copyright lowRISC contributors (COSMIC project).
+// Licensed under the Apache License, Version 2.0, see LICENSE for details.
+// SPDX-License-Identifier: Apache-2.0
+
+// Design Verification (DV) register window.
+
+#pragma once
+
+#include <stdint.h>
+
+/* These values are written to the test_status register of the DV window
+ * throughout a test to indicate test progression and outcome. */
+enum dv_test_status : uint32_t {
+    /* Test code has begun. */
+    dv_test_status_in_test = 0x4354u,
+    /* The test has passed. */
+    dv_test_status_passed = 0x900du,
+    /* The test has failed. */
+    dv_test_status_failed = 0xbaadu,
+};
+
+/* These values are provided by the DV window from the hw_id register to
+ * indicate the current test platform. */
+enum dv_hwid : uint32_t {
+    /* Running on the Genesys2 FPGA. */
+    dv_hwid_fpga_genesys2 = 0xau,
+    /* Running in a Verilator simulation. */
+    dv_hwid_sim_verilator = 0x1au,
+    /* Running in a UVM simulation. */
+    dv_hwid_sim_uvm = 0x2au,
+};
+
+typedef volatile struct [[gnu::aligned(4)]] dv_window_memory_layout {
+    /* test_status (0x0) */
+    uint32_t test_status;
+
+    /* hw_id (0x4) */
+    const uint32_t hw_id;
+
+    const uint8_t __reserved0[0x100 - 0x08];
+} *dv_window_t;
+
+
+_Static_assert(__builtin_offsetof(struct dv_window_memory_layout, test_status) == 0x0ul,
+               "incorrect register test_status offset");
+_Static_assert(__builtin_offsetof(struct dv_window_memory_layout, hw_id) == 0x4ul,
+               "incorrect register hw_id offset");

sw/device/lib/hal/mocha.c

@@ -13,7 +13,7 @@
 
 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 dv_window_base = 0x20020000ul;
 static const uintptr_t ethernet_base = 0x30000000ul;
 static const uintptr_t gpio_base = 0x40000000ul;
 static const uintptr_t clkmgr_base = 0x40020000ul;
@@ -193,11 +193,12 @@ void *mocha_system_dram(void)
 #endif /* defined(__riscv_zcherihybrid) */
 }
 
-void *mocha_system_dv_test_status(void)
+dv_window_t mocha_system_dv_window(void)
 {
 #if defined(__riscv_zcherihybrid)
-    return create_mmio_capability(dv_test_status_base, 0x100u);
+    return (
+        dv_window_t)create_mmio_capability(dv_window_base, sizeof(struct dv_window_memory_layout));
 #else /* !defined(__riscv_zcherihybrid) */
-    return (void *)dv_test_status_base;
+    return (dv_window_t)dv_window_base;
 #endif /* defined(__riscv_zcherihybrid) */
 }

sw/device/lib/hal/mocha.h

@@ -7,6 +7,7 @@
 #pragma once
 
 #include "hal/clkmgr.h"
+#include "hal/dv.h"
 #include "hal/entropy_src.h"
 #include "hal/ethernet.h"
 #include "hal/gpio.h"
@@ -50,5 +51,4 @@ timer_t mocha_system_timer(void);
 spi_host_t mocha_system_spi_host(void);
 plic_t mocha_system_plic(void);
 void *mocha_system_dram(void);
-
-void *mocha_system_dv_test_status(void);
+dv_window_t mocha_system_dv_window(void);

sw/device/lib/test_framework/main.c

@@ -3,6 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include "boot/trap.h"
+#include "hal/dv.h"
 #include "hal/hart.h"
 #include "hal/mmio.h"
 #include "hal/mocha.h"
@@ -12,12 +13,6 @@
 #include <stdbool.h>
 #include <stdint.h>
 
-enum test_status {
-    TEST_STATUS_IN_TEST = 0x4354u,
-    TEST_STATUS_PASSED = 0x900du,
-    TEST_STATUS_FAILED = 0xbaadu,
-};
-
 /* magic byte string to terminate the verilator simulation */
 static const char magic[] = "\xd8\xaf\xfb\xa0\xc7\xe1\xa9\xd7";
 
@@ -53,11 +48,11 @@ test_exception_handler(struct trap_registers *registers, struct trap_context *co
 [[noreturn]] void test_exit(bool success)
 {
     uart_t console = mocha_system_uart();
-    void *dv_test_status = mocha_system_dv_test_status();
+    dv_window_t dv_window = mocha_system_dv_window();
 
     uart_puts(console, "TEST RESULT: ");
     uart_puts(console, success ? "PASSED" : "FAILED");
-    DEV_WRITE(dv_test_status, success ? TEST_STATUS_PASSED : TEST_STATUS_FAILED);
+    DEV_WRITE(&dv_window->test_status, success ? dv_test_status_passed : dv_test_status_failed);
 
     uart_putchar(console, '\n');
     uart_puts(console, "Safe to exit simulator.");
@@ -75,12 +70,13 @@ test_exception_handler(struct trap_registers *registers, struct trap_context *co
 [[noreturn]] void main(void)
 {
     uart_t console = mocha_system_uart();
-    void *dv_test_status = mocha_system_dv_test_status();
+    dv_window_t dv_window = mocha_system_dv_window();
 
     uart_init(console);
     // Flush the uart
     uart_wait_for(console, uart_status_txidle);
-    DEV_WRITE(dv_test_status, TEST_STATUS_IN_TEST);
+
+    DEV_WRITE(&dv_window->test_status, dv_test_status_in_test);
 
     bool result = test_main(console);
     // Flush the uart