SoC: Add SIMU=spike support for hbirdv2

Signed-off-by: Huaqi Fang <[email protected]>

SoC/hbirdv2/Common/Include/hbirdv2.h

@@ -138,7 +138,11 @@ typedef enum EXCn {
 #endif /* __riscv_xlen == 64 */
 
 /* ToDo: define the correct core features for the hbird */
+#ifndef SIMULATION_SPIKE
 #define __PLIC_PRESENT            1                     /*!< Set to 1 if PLIC is present */
+#else
+#define __PLIC_PRESENT            0                     /*!< Set to 1 if PLIC is present */
+#endif
 #ifdef SIMULATION_XLSPIKE
 #define __PLIC_BASEADDR           0x08000000UL          /*!< Set to PLIC baseaddr of your device */
 #else

SoC/hbirdv2/Common/Include/htif.h

@@ -0,0 +1,19 @@
+/*
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright (c) 2010-2020, The Regents of the University of California
+ * (Regents).  All Rights Reserved.
+ */
+
+#ifndef __SYS_HTIF_H__
+#define __SYS_HTIF_H__
+
+#include <stdint.h>
+
+void htif_putc(char ch);
+
+int htif_getc(void);
+
+int htif_system_reset(uint32_t type);
+
+#endif

SoC/hbirdv2/Common/Source/Drivers/hbirdv2_uart.c

@@ -68,10 +68,15 @@ int32_t uart_write(UART_TypeDef *uart, uint8_t val)
     if (__RARELY(uart == NULL)) {
         return -1;
     }
+#ifndef SIMULATION_SPIKE
 #ifndef SIMULATION_XLSPIKE
     while ((uart->LSR & 0x20) == 0);
 #endif
     uart->THR = val;
+#else
+    extern void htif_putc(char ch);
+    htif_putc(val);
+#endif
     return 0;
 }
 
@@ -139,7 +144,7 @@ int32_t uart_disable_rx_th_int(UART_TypeDef *uart)
     if (__RARELY(uart == NULL)) {
         return -1;
     }
-    
+
     uart->IER &= 0xFFFFFFFE;
     return 0;
 }
@@ -159,7 +164,7 @@ int32_t uart_disable_rx_err_int(UART_TypeDef *uart)
     if (__RARELY(uart == NULL)) {
         return -1;
     }
-    
+
     uart->IER &= 0xFFFFFFFB;
     return 0;
 }

SoC/hbirdv2/Common/Source/Drivers/htif.c

@@ -0,0 +1,158 @@
+/*
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright (c) 2010-2020, The Regents of the University of California
+ * (Regents).  All Rights Reserved.
+ * 
+ * Notice:
+ * 2020.08.18 Modified for HBird SDK
+ */
+#ifdef SIMULATION_SPIKE
+#include <stdint.h>
+
+#define HTIF_DATA_BITS		48
+#define HTIF_DATA_MASK		((1ULL << HTIF_DATA_BITS) - 1)
+#define HTIF_DATA_SHIFT		0
+#define HTIF_CMD_BITS		8
+#define HTIF_CMD_MASK		((1ULL << HTIF_CMD_BITS) - 1)
+#define HTIF_CMD_SHIFT		48
+#define HTIF_DEV_BITS		8
+#define HTIF_DEV_MASK		((1ULL << HTIF_DEV_BITS) - 1)
+#define HTIF_DEV_SHIFT		56
+
+#define HTIF_DEV_SYSTEM		0
+#define HTIF_DEV_CONSOLE	1
+
+#define HTIF_CONSOLE_CMD_GETC	0
+#define HTIF_CONSOLE_CMD_PUTC	1
+
+#if __riscv_xlen == 64
+# define TOHOST_CMD(dev, cmd, payload) \
+	(((uint64_t)(dev) << HTIF_DEV_SHIFT) | \
+	 ((uint64_t)(cmd) << HTIF_CMD_SHIFT) | \
+	 (uint64_t)(payload))
+#else
+# define TOHOST_CMD(dev, cmd, payload) ({ \
+  if ((dev) || (cmd)) __builtin_trap(); \
+  (payload); })
+#endif
+#define FROMHOST_DEV(fromhost_value) \
+	((uint64_t)((fromhost_value) >> HTIF_DEV_SHIFT) & HTIF_DEV_MASK)
+#define FROMHOST_CMD(fromhost_value) \
+	((uint64_t)((fromhost_value) >> HTIF_CMD_SHIFT) & HTIF_CMD_MASK)
+#define FROMHOST_DATA(fromhost_value) \
+	((uint64_t)((fromhost_value) >> HTIF_DATA_SHIFT) & HTIF_DATA_MASK)
+
+#define PK_SYS_write 64
+
+volatile uint64_t tohost __attribute__((section(".htif")));
+volatile uint64_t fromhost __attribute__((section(".htif")));
+static int htif_console_buf;
+//static spinlock_t htif_lock = SPIN_LOCK_INITIALIZER;
+
+
+static int htif_lock;
+#define spin_lock(x)
+#define spin_unlock(x)
+
+static void __check_fromhost()
+{
+	uint64_t fh = fromhost;
+	if (!fh)
+		return;
+	fromhost = 0;
+
+	/* this should be from the console */
+	if (FROMHOST_DEV(fh) != HTIF_DEV_CONSOLE)
+		__builtin_trap();
+	switch (FROMHOST_CMD(fh)) {
+		case HTIF_CONSOLE_CMD_GETC:
+			htif_console_buf = 1 + (uint8_t)FROMHOST_DATA(fh);
+			break;
+		case HTIF_CONSOLE_CMD_PUTC:
+			break;
+		default:
+			__builtin_trap();
+	}
+}
+
+static void __set_tohost(uint64_t dev, uint64_t cmd, uint64_t data)
+{
+	while (tohost)
+		__check_fromhost();
+	tohost = TOHOST_CMD(dev, cmd, data);
+}
+
+#if __riscv_xlen == 32
+static void do_tohost_fromhost(uint64_t dev, uint64_t cmd, uint64_t data)
+{
+	spin_lock(&htif_lock);
+
+	__set_tohost(HTIF_DEV_SYSTEM, cmd, data);
+
+	while (1) {
+		uint64_t fh = fromhost;
+		if (fh) {
+			if (FROMHOST_DEV(fh) == HTIF_DEV_SYSTEM &&
+			    FROMHOST_CMD(fh) == cmd) {
+				fromhost = 0;
+				break;
+			}
+			__check_fromhost();
+		}
+	}
+
+	spin_unlock(&htif_lock);
+}
+
+void htif_putc(char ch)
+{
+	/* HTIF devices are not supported on RV32, so do a proxy write call */
+	volatile uint64_t magic_mem[8];
+	magic_mem[0] = PK_SYS_write;
+	magic_mem[1] = HTIF_DEV_CONSOLE;
+	magic_mem[2] = (uint64_t)(uintptr_t)&ch;
+	magic_mem[3] = HTIF_CONSOLE_CMD_PUTC;
+	do_tohost_fromhost(HTIF_DEV_SYSTEM, 0, (uint64_t)(uintptr_t)magic_mem);
+}
+#else
+void htif_putc(char ch)
+{
+	spin_lock(&htif_lock);
+	__set_tohost(HTIF_DEV_CONSOLE, HTIF_CONSOLE_CMD_PUTC, ch);
+	spin_unlock(&htif_lock);
+}
+#endif
+
+int htif_getc(void)
+{
+	int ch;
+
+#if __riscv_xlen == 32
+	/* HTIF devices are not supported on RV32 */
+	return -1;
+#endif
+
+	spin_lock(&htif_lock);
+
+	__check_fromhost();
+	ch = htif_console_buf;
+	if (ch >= 0) {
+		htif_console_buf = -1;
+		__set_tohost(HTIF_DEV_CONSOLE, HTIF_CONSOLE_CMD_GETC, 0);
+	}
+
+	spin_unlock(&htif_lock);
+
+	return ch - 1;
+}
+
+int htif_system_reset(uint32_t type)
+{
+	while (1) {
+		fromhost = 0;
+		tohost = 1;
+	}
+}
+
+#endif

SoC/hbirdv2/Common/Source/hbirdv2_common.c

@@ -57,3 +57,22 @@ void delay_1ms(uint32_t count)
         delta_mtime = SysTimer_GetLoadValue() - start_mtime;
     } while (delta_mtime < delay_ticks);
 }
+
+#ifdef SIMULATION_XLSPIKE
+// never return for xlspike
+void xlspike_exit(int status)
+{
+    // pass exit status via rxfifo register
+    UART0->RXFIFO = status;
+    uart_write(UART0, 4);
+}
+#endif
+
+#ifdef SIMULATION_SPIKE
+// never return for spike
+void spike_exit(int status)
+{
+    extern int htif_system_reset(uint32_t type);
+    htif_system_reset(status);
+}
+#endif

SoC/hbirdv2/Common/Source/system_hbirdv2.c

@@ -465,9 +465,13 @@ int32_t PLIC_Register_IRQ(uint32_t source, uint8_t priority, void *handler)
 void _premain_init(void)
 {
     /* TODO: Add your own initialization code here, called before main */
+#ifndef SIMULATION_SPIKE
     SystemCoreClock = get_cpu_freq();
     gpio_iof_config(GPIOA, IOF_UART_MASK);
     uart_init(SOC_DEBUG_UART, 115200);
+#else
+    SystemCoreClock = 1000000;
+#endif
     /* Display banner after UART initialized */
     SystemBannerPrint();
     /* Initialize exception default handlers */
@@ -488,10 +492,17 @@ void _premain_init(void)
  * by __libc_fini_array function, so we defined a new function
  * to do initialization
  */
-void _postmain_fini(void)
+void _postmain_fini(int status)
 {
     /* TODO: Add your own finishing code here, called after main */
-
+#ifdef SIMULATION_XLSPIKE
+extern void xlspike_exit(int status);
+    xlspike_exit(status);
+#endif
+#ifdef SIMULATION_SPIKE
+extern void spike_exit(int status);
+    spike_exit(status);
+#endif
 }
 
 /**