lib: sbi: Simplify system reset platform operations

Instead of having system_reset_check() and system_reset() callbacks
in platform operations, it will be much simpler for reset driver to
directly register these operations as a device to the sbi_system
implementation.

Signed-off-by: Anup Patel <anup.patel@wdc.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>

include/sbi/sbi_platform.h

@@ -127,11 +127,6 @@ struct sbi_platform_operations {
 	 */
 	int (*hart_suspend)(u32 suspend_type, ulong raddr);
 
-	/* Check whether reset type and reason supported by the platform */
-	int (*system_reset_check)(u32 reset_type, u32 reset_reason);
-	/** Reset the platform */
-	void (*system_reset)(u32 reset_type, u32 reset_reason);
-
 	/** platform specific SBI extension implementation probe function */
 	int (*vendor_ext_check)(long extid);
 	/** platform specific SBI extension implementation provider */
@@ -572,41 +567,6 @@ static inline void sbi_platform_timer_exit(const struct sbi_platform *plat)
 		sbi_platform_ops(plat)->timer_exit();
 }
 
-/**
- * Check whether reset type and reason supported by the platform
- *
- * @param plat pointer to struct sbi_platform
- * @param reset_type type of reset
- * @param reset_reason reason for reset
- *
- * @return 0 if reset type and reason not supported and 1 if supported
- */
-static inline int sbi_platform_system_reset_check(
-					    const struct sbi_platform *plat,
-					    u32 reset_type, u32 reset_reason)
-{
-	if (plat && sbi_platform_ops(plat)->system_reset_check)
-		return sbi_platform_ops(plat)->system_reset_check(reset_type,
-								  reset_reason);
-	return 0;
-}
-
-/**
- * Reset the platform
- *
- * This function will not return for supported reset type and reset reason
- *
- * @param plat pointer to struct sbi_platform
- * @param reset_type type of reset
- * @param reset_reason reason for reset
- */
-static inline void sbi_platform_system_reset(const struct sbi_platform *plat,
-					     u32 reset_type, u32 reset_reason)
-{
-	if (plat && sbi_platform_ops(plat)->system_reset)
-		sbi_platform_ops(plat)->system_reset(reset_type, reset_reason);
-}
-
 /**
  * Check if a vendor extension is implemented or not.
  *

include/sbi/sbi_system.h

@@ -12,6 +12,22 @@
 
 #include <sbi/sbi_types.h>
 
+/** System reset hardware device */
+struct sbi_system_reset_device {
+	/** Name of the system reset device */
+	char name[32];
+
+	/* Check whether reset type and reason supported by the device */
+	int (*system_reset_check)(u32 reset_type, u32 reset_reason);
+
+	/** Reset the system */
+	void (*system_reset)(u32 reset_type, u32 reset_reason);
+};
+
+const struct sbi_system_reset_device *sbi_system_reset_get_device(void);
+
+void sbi_system_reset_set_device(const struct sbi_system_reset_device *dev);
+
 bool sbi_system_reset_supported(u32 reset_type, u32 reset_reason);
 
 void __noreturn sbi_system_reset(u32 reset_type, u32 reset_reason);

include/sbi_utils/reset/fdt_reset.h

@@ -15,14 +15,8 @@
 struct fdt_reset {
 	const struct fdt_match *match_table;
 	int (*init)(void *fdt, int nodeoff, const struct fdt_match *match);
-	int (*system_reset_check)(u32 reset_type, u32 reset_reason);
-	void (*system_reset)(u32 reset_type, u32 reset_reason);
 };
 
-int fdt_system_reset_check(u32 reset_type, u32 reset_reason);
-
-void fdt_system_reset(u32 reset_type, u32 reset_reason);
-
 int fdt_reset_init(void);
 
 #endif

include/sbi_utils/sys/htif.h

@@ -12,8 +12,6 @@
 
 int htif_serial_init(void);
 
-int htif_system_reset_check(u32 type, u32 reason);
-
-void htif_system_reset(u32 type, u32 reason);
+int htif_system_reset_init(void);
 
 #endif

include/sbi_utils/sys/sifive_test.h

@@ -12,10 +12,6 @@
 
 #include <sbi/sbi_types.h>
 
-int sifive_test_system_reset_check(u32 type, u32 reason);
-
-void sifive_test_system_reset(u32 type, u32 reason);
-
 int sifive_test_init(unsigned long base);
 
 #endif

lib/sbi/sbi_system.c

@@ -18,10 +18,25 @@
 #include <sbi/sbi_ipi.h>
 #include <sbi/sbi_init.h>
 
+static const struct sbi_system_reset_device *reset_dev = NULL;
+
+const struct sbi_system_reset_device *sbi_system_reset_get_device(void)
+{
+	return reset_dev;
+}
+
+void sbi_system_reset_set_device(const struct sbi_system_reset_device *dev)
+{
+	if (!dev || reset_dev)
+		return;
+
+	reset_dev = dev;
+}
+
 bool sbi_system_reset_supported(u32 reset_type, u32 reset_reason)
 {
-	if (sbi_platform_system_reset_check(sbi_platform_thishart_ptr(),
-					    reset_type, reset_reason))
+	if (reset_dev && reset_dev->system_reset_check &&
+	    reset_dev->system_reset_check(reset_type, reset_reason))
 		return TRUE;
 
 	return FALSE;
@@ -47,9 +62,9 @@ void __noreturn sbi_system_reset(u32 reset_type, u32 reset_reason)
 	sbi_hsm_hart_stop(scratch, FALSE);
 
 	/* Platform specific reset if domain allowed system reset */
-	if (dom->system_reset_allowed)
-		sbi_platform_system_reset(sbi_platform_ptr(scratch),
-					  reset_type, reset_reason);
+	if (dom->system_reset_allowed &&
+	    reset_dev && reset_dev->system_reset)
+		reset_dev->system_reset(reset_type, reset_reason);
 
 	/* If platform specific reset did not work then do sbi_exit() */
 	sbi_exit(scratch);

lib/utils/reset/fdt_reset.c

@@ -23,20 +23,6 @@ static struct fdt_reset *reset_drivers[] = {
 
 static struct fdt_reset *current_driver = NULL;
 
-int fdt_system_reset_check(u32 reset_type, u32 reset_reason)
-{
-	if (current_driver && current_driver->system_reset_check)
-		return current_driver->system_reset_check(reset_type,
-							  reset_reason);
-	return 0;
-}
-
-void fdt_system_reset(u32 reset_type, u32 reset_reason)
-{
-	if (current_driver && current_driver->system_reset)
-		current_driver->system_reset(reset_type, reset_reason);
-}
-
 int fdt_reset_init(void)
 {
 	int pos, noff, rc;

lib/utils/reset/fdt_reset_htif.c

@@ -11,6 +11,12 @@
 #include <sbi_utils/fdt/fdt_helper.h>
 #include <sbi_utils/sys/htif.h>
 
+static int htif_reset_init(void *fdt, int nodeoff,
+			   const struct fdt_match *match)
+{
+	return htif_system_reset_init();
+}
+
 static const struct fdt_match htif_reset_match[] = {
 	{ .compatible = "ucb,htif0" },
 	{ },
@@ -18,6 +24,5 @@ static const struct fdt_match htif_reset_match[] = {
 
 struct fdt_reset fdt_reset_htif = {
 	.match_table = htif_reset_match,
-	.system_reset_check = htif_system_reset_check,
-	.system_reset = htif_system_reset
+	.init = htif_reset_init
 };

lib/utils/reset/fdt_reset_sifive.c

@@ -33,6 +33,4 @@ static const struct fdt_match sifive_test_reset_match[] = {
 struct fdt_reset fdt_reset_sifive = {
 	.match_table = sifive_test_reset_match,
 	.init = sifive_test_reset_init,
-	.system_reset_check = sifive_test_system_reset_check,
-	.system_reset = sifive_test_system_reset
 };

lib/utils/reset/fdt_reset_thead.c

@@ -7,8 +7,10 @@
 #include <sbi/sbi_bitops.h>
 #include <sbi/sbi_hart.h>
 #include <sbi/sbi_scratch.h>
+#include <sbi/sbi_system.h>
 #include <sbi_utils/fdt/fdt_helper.h>
 #include <sbi_utils/reset/fdt_reset.h>
+
 #include "fdt_reset_thead.h"
 
 struct custom_csr custom_csr[MAX_CUSTOM_CSR];
@@ -37,6 +39,22 @@ static void clone_csrs(int cnt)
 	}
 }
 
+static int thead_system_reset_check(u32 type, u32 reason)
+{
+	return 1;
+}
+
+static void thead_system_reset(u32 type, u32 reason)
+{
+	ebreak();
+}
+
+static struct sbi_system_reset_device thead_reset = {
+	.name = "thead_reset",
+	.system_reset_check = thead_system_reset_check,
+	.system_reset = thead_system_reset
+};
+
 extern void __thead_pre_start_warm(void);
 static int thead_reset_init(void *fdt, int nodeoff,
 				 const struct fdt_match *match)
@@ -106,19 +124,11 @@ static int thead_reset_init(void *fdt, int nodeoff,
 		}
 	}
 
+	sbi_system_reset_set_device(&thead_reset);
+
 	return 0;
 }
 
-int thead_system_reset_check(u32 type, u32 reason)
-{
-	return 1;
-}
-
-void thead_system_reset(u32 type, u32 reason)
-{
-	ebreak();
-}
-
 static const struct fdt_match thead_reset_match[] = {
 	{ .compatible = "thead,reset-sample" },
 	{ },
@@ -126,7 +136,5 @@ static const struct fdt_match thead_reset_match[] = {
 
 struct fdt_reset fdt_reset_thead = {
 	.match_table = thead_reset_match,
-	.init = thead_reset_init,
-	.system_reset_check = thead_system_reset_check,
-	.system_reset = thead_system_reset
+	.init = thead_reset_init
 };

lib/utils/sys/htif.c

@@ -7,6 +7,7 @@
 
 #include <sbi/riscv_locks.h>
 #include <sbi/sbi_console.h>
+#include <sbi/sbi_system.h>
 #include <sbi_utils/sys/htif.h>
 
 #define HTIF_DATA_BITS		48
@@ -154,15 +155,28 @@ int htif_serial_init(void)
 	return 0;
 }
 
-int htif_system_reset_check(u32 type, u32 reason)
+static int htif_system_reset_check(u32 type, u32 reason)
 {
 	return 1;
 }
 
-void htif_system_reset(u32 type, u32 reason)
+static void htif_system_reset(u32 type, u32 reason)
 {
 	while (1) {
 		fromhost = 0;
 		tohost = 1;
 	}
 }
+
+static struct sbi_system_reset_device htif_reset = {
+	.name = "htif",
+	.system_reset_check = htif_system_reset_check,
+	.system_reset = htif_system_reset
+};
+
+int htif_system_reset_init(void)
+{
+	sbi_system_reset_set_device(&htif_reset);
+
+	return 0;
+}

lib/utils/sys/sifive_test.c

@@ -9,6 +9,7 @@
 
 #include <sbi/riscv_io.h>
 #include <sbi/sbi_ecall_interface.h>
+#include <sbi/sbi_system.h>
 #include <sbi_utils/sys/sifive_test.h>
 
 #define FINISHER_FAIL		0x3333
@@ -17,7 +18,7 @@
 
 static void *sifive_test_base;
 
-int sifive_test_system_reset_check(u32 type, u32 reason)
+static int sifive_test_system_reset_check(u32 type, u32 reason)
 {
 	switch (type) {
 	case SBI_SRST_RESET_TYPE_SHUTDOWN:
@@ -29,7 +30,7 @@ int sifive_test_system_reset_check(u32 type, u32 reason)
 	return 0;
 }
 
-void sifive_test_system_reset(u32 type, u32 reason)
+static void sifive_test_system_reset(u32 type, u32 reason)
 {
 	/*
 	 * Tell the "finisher" that the simulation
@@ -49,9 +50,16 @@ void sifive_test_system_reset(u32 type, u32 reason)
 	}
 }
 
+static struct sbi_system_reset_device sifive_test_reset = {
+	.name = "sifive_test",
+	.system_reset_check = sifive_test_system_reset_check,
+	.system_reset = sifive_test_system_reset
+};
+
 int sifive_test_init(unsigned long base)
 {
 	sifive_test_base = (void *)base;
+	sbi_system_reset_set_device(&sifive_test_reset);
 
 	return 0;
 }

platform/generic/include/platform_override.h

@@ -20,10 +20,6 @@ struct platform_override {
 	int (*final_init)(bool cold_boot, const struct fdt_match *match);
 	void (*early_exit)(const struct fdt_match *match);
 	void (*final_exit)(const struct fdt_match *match);
-	int (*system_reset_check)(u32 reset_type, u32 reset_reason,
-				  const struct fdt_match *match);
-	void (*system_reset)(u32 reset_type, u32 reset_reason,
-			     const struct fdt_match *match);
 	int (*fdt_fixup)(void *fdt, const struct fdt_match *match);
 };
 

platform/generic/platform.c

@@ -184,26 +184,6 @@ static u64 generic_tlbr_flush_limit(void)
 	return SBI_PLATFORM_TLB_RANGE_FLUSH_LIMIT_DEFAULT;
 }
 
-static int generic_system_reset_check(u32 reset_type, u32 reset_reason)
-{
-	if (generic_plat && generic_plat->system_reset_check)
-		return generic_plat->system_reset_check(reset_type,
-							reset_reason,
-							generic_plat_match);
-	return fdt_system_reset_check(reset_type, reset_reason);
-}
-
-static void generic_system_reset(u32 reset_type, u32 reset_reason)
-{
-	if (generic_plat && generic_plat->system_reset) {
-		generic_plat->system_reset(reset_type, reset_reason,
-					   generic_plat_match);
-		return;
-	}
-
-	fdt_system_reset(reset_type, reset_reason);
-}
-
 const struct sbi_platform_operations platform_ops = {
 	.early_init		= generic_early_init,
 	.final_init		= generic_final_init,
@@ -218,8 +198,6 @@ const struct sbi_platform_operations platform_ops = {
 	.get_tlbr_flush_limit	= generic_tlbr_flush_limit,
 	.timer_init		= fdt_timer_init,
 	.timer_exit		= fdt_timer_exit,
-	.system_reset_check	= generic_system_reset_check,
-	.system_reset		= generic_system_reset,
 };
 
 struct sbi_platform platform = {

platform/kendryte/k210/platform.c

@@ -12,6 +12,7 @@
 #include <sbi/sbi_console.h>
 #include <sbi/sbi_const.h>
 #include <sbi/sbi_platform.h>
+#include <sbi/sbi_system.h>
 #include <sbi_utils/fdt/fdt_fixup.h>
 #include <sbi_utils/irqchip/plic.h>
 #include <sbi_utils/serial/sifive-uart.h>
@@ -68,6 +69,36 @@ static u32 k210_get_clk_freq(void)
 	return pll0_freq / div;
 }
 
+static int k210_system_reset_check(u32 type, u32 reason)
+{
+	return 1;
+}
+
+static void k210_system_reset(u32 type, u32 reason)
+{
+	u32 val;
+
+	val = k210_read_sysreg(K210_RESET);
+	val |= K210_RESET_MASK;
+	k210_write_sysreg(val, K210_RESET);
+
+	while (1);
+}
+
+static struct sbi_system_reset_device k210_reset = {
+	.name = "kendryte_k210_reset",
+	.system_reset_check = k210_system_reset_check,
+	.system_reset = k210_system_reset
+};
+
+static int k210_early_init(bool cold_boot)
+{
+	if (cold_boot)
+		sbi_system_reset_set_device(&k210_reset);
+
+	return 0;
+}
+
 static int k210_final_init(bool cold_boot)
 {
 	void *fdt;
@@ -129,23 +160,9 @@ static int k210_timer_init(bool cold_boot)
 	return clint_warm_timer_init();
 }
 
-static int k210_system_reset_check(u32 type, u32 reason)
-{
-	return 1;
-}
-
-static void k210_system_reset(u32 type, u32 reason)
-{
-	u32 val;
-
-	val = k210_read_sysreg(K210_RESET);
-	val |= K210_RESET_MASK;
-	k210_write_sysreg(val, K210_RESET);
-
-	while (1);
-}
-
 const struct sbi_platform_operations platform_ops = {
+	.early_init	= k210_early_init,
+
 	.final_init	= k210_final_init,
 
 	.console_init	= k210_console_init,
@@ -154,9 +171,6 @@ const struct sbi_platform_operations platform_ops = {
 
 	.ipi_init  = k210_ipi_init,
 
-	.system_reset_check	= k210_system_reset_check,
-	.system_reset		= k210_system_reset,
-
 	.timer_init	   = k210_timer_init,
 };
 

platform/nuclei/ux600/platform.c

@@ -15,6 +15,7 @@
 #include <sbi/sbi_console.h>
 #include <sbi/sbi_const.h>
 #include <sbi/sbi_platform.h>
+#include <sbi/sbi_system.h>
 #include <sbi_utils/fdt/fdt_fixup.h>
 #include <sbi_utils/irqchip/plic.h>
 #include <sbi_utils/serial/sifive-uart.h>
@@ -104,10 +105,32 @@ static u32 ux600_get_clk_freq(void)
 	return cpu_freq;
 }
 
+static int ux600_system_reset_check(u32 type, u32 reason)
+{
+	return 1;
+}
+
+static void ux600_system_reset(u32 type, u32 reason)
+{
+	/* Reset system using MSFTRST register in Nuclei Timer. */
+	writel(UX600_NUCLEI_TIMER_MSFTRST_KEY, (void *)(UX600_NUCLEI_TIMER_ADDR
+					+ UX600_NUCLEI_TIMER_MSFTRST_OFS));
+	while(1);
+}
+
+static struct sbi_system_reset_device ux600_reset = {
+	.name = "nuclei_ux600_reset",
+	.system_reset_check = ux600_system_reset_check,
+	.system_reset = ux600_system_reset
+};
+
 static int ux600_early_init(bool cold_boot)
 {
 	u32 regval;
 
+	if (cold_boot)
+		sbi_system_reset_set_device(&ux600_reset);
+
 	/* Measure CPU Frequency using Timer */
 	ux600_clk_freq = ux600_get_clk_freq();
 
@@ -186,19 +209,6 @@ static int ux600_timer_init(bool cold_boot)
 	return clint_warm_timer_init();
 }
 
-static int ux600_system_reset_check(u32 type, u32 reason)
-{
-	return 1;
-}
-
-static void ux600_system_reset(u32 type, u32 reason)
-{
-	/* Reset system using MSFTRST register in Nuclei Timer. */
-	writel(UX600_NUCLEI_TIMER_MSFTRST_KEY, (void *)(UX600_NUCLEI_TIMER_ADDR
-					+ UX600_NUCLEI_TIMER_MSFTRST_OFS));
-	while(1);
-}
-
 const struct sbi_platform_operations platform_ops = {
 	.early_init		= ux600_early_init,
 	.final_init		= ux600_final_init,
@@ -206,8 +216,6 @@ const struct sbi_platform_operations platform_ops = {
 	.irqchip_init		= ux600_irqchip_init,
 	.ipi_init		= ux600_ipi_init,
 	.timer_init		= ux600_timer_init,
-	.system_reset_check	= ux600_system_reset_check,
-	.system_reset		= ux600_system_reset
 };
 
 const struct sbi_platform platform = {

platform/template/platform.c

@@ -115,21 +115,6 @@ static int platform_timer_init(bool cold_boot)
 	return clint_warm_timer_init();
 }
 
-/*
- * Check reset type and reason supported by the platform.
- */
-static int platform_system_reset_check(u32 type, u32 reason)
-{
-	return 0;
-}
-
-/*
- * Reset the platform.
- */
-static void platform_system_reset(u32 type, u32 reason)
-{
-}
-
 /*
  * Platform descriptor.
  */
@@ -139,9 +124,7 @@ const struct sbi_platform_operations platform_ops = {
 	.console_init		= platform_console_init,
 	.irqchip_init		= platform_irqchip_init,
 	.ipi_init		= platform_ipi_init,
-	.timer_init		= platform_timer_init,
-	.system_reset_check	= platform_system_reset_check,
-	.system_reset		= platform_system_reset
+	.timer_init		= platform_timer_init
 };
 const struct sbi_platform platform = {
 	.opensbi_version	= OPENSBI_VERSION,