From 9ed6707716b72a88ba6b31219b766c1562aec8d0 Mon Sep 17 00:00:00 2001
From: Tim Newsome <tim@sifive.com>
Date: Fri, 17 Jul 2020 14:57:23 -0700
Subject: [PATCH] Further deprecate `-rtos riscv`. (#499)

* Further deprecate `-rtos riscv`.

Now using `-rtos riscv` will result in a failure, which you can (until
the end of this year) bypass by adding `enable_rtos_riscv` to the
configuration.

Change-Id: Ic714c303dc1b00c19e8956609730c0f83c845cb6

* Make checkpatch happy.

Change-Id: I0469ec37d38ad2eadf25efb5b2b7ac88391c0f51
---
 src/rtos/riscv_debug.c | 27 ++++++++++++++++++++-------
 src/target/target.c    | 19 +++++++++++++++++++
 2 files changed, 39 insertions(+), 7 deletions(-)

diff --git a/src/rtos/riscv_debug.c b/src/rtos/riscv_debug.c
index d136530fb..af8c4f1f8 100644
--- a/src/rtos/riscv_debug.c
+++ b/src/rtos/riscv_debug.c
@@ -18,16 +18,29 @@ static bool riscv_detect_rtos(struct target *target)
 	return -1;
 }
 
+extern bool enable_rtos_riscv;
+
 static int riscv_create_rtos(struct target *target)
 {
 	LOG_DEBUG("RISC-V Debug 'RTOS' created: this doesn't mean you're running an RTOS, just that you have multi-hart support on RISC-V");
-	LOG_WARNING("`-rtos riscv` is deprecated! Please change your configuration to use `-rtos");
-	LOG_WARNING("hwthread` instead. To do that, you will have to explicitly list every hart in");
-	LOG_WARNING("the system as a separate target. See");
-	LOG_WARNING("https://github.com/riscv/riscv-tests/blob/ec6537fc4a527ca88be2f045e01c460e640ab9c5/debug/targets/SiFive/HiFiveUnleashed.cfg#L11");
-	LOG_WARNING("for an example.");
-	LOG_WARNING("You will have to change your configuration file in any OpenOCD newer than June");
-	LOG_WARNING("2020.");
+
+	if (enable_rtos_riscv) {
+		LOG_WARNING("`-rtos riscv` is deprecated and will be removed at the end of 2020! Please");
+		LOG_WARNING("change your configuration to use `-rtos hwthread` instead. To do that, you");
+		LOG_WARNING("will have to explicitly list every hart in the system as a separate target. See");
+		LOG_WARNING("https://github.com/riscv/riscv-tests/blob/ec6537fc4a527ca88be2f045e01c460e640ab9c5/debug/targets/SiFive/HiFiveUnleashed.cfg#L11");
+		LOG_WARNING("for an example.");
+	} else {
+		LOG_ERROR("`-rtos riscv` is deprecated and will be removed at the end of 2020! Until");
+		LOG_ERROR("then, you can still use it by adding `enable_rtos_riscv` to your");
+		LOG_ERROR("configuration.");
+		LOG_ERROR("Please change your configuration to use `-rtos hwthread` instead. To do ");
+		LOG_ERROR("that, you will have to explicitly list every hart in the system as a separate ");
+		LOG_ERROR("target. See");
+		LOG_ERROR("https://github.com/riscv/riscv-tests/blob/ec6537fc4a527ca88be2f045e01c460e640ab9c5/debug/targets/SiFive/HiFiveUnleashed.cfg#L11");
+		LOG_ERROR("for an example.");
+		return ERROR_FAIL;
+	}
 
 	struct riscv_rtos *r = calloc(1, sizeof(*r));
 	target->rtos->rtos_specific_params = r;
diff --git a/src/target/target.c b/src/target/target.c
index bccafbfa2..ad33fa404 100644
--- a/src/target/target.c
+++ b/src/target/target.c
@@ -5948,6 +5948,17 @@ COMMAND_HANDLER(handle_fast_load_command)
 	return retval;
 }
 
+bool enable_rtos_riscv;
+COMMAND_HANDLER(handle_enable_rtos_riscv_command)
+{
+	if (CMD_ARGC != 0) {
+		LOG_ERROR("Command takes no arguments");
+		return ERROR_COMMAND_SYNTAX_ERROR;
+	}
+	enable_rtos_riscv = true;
+	return ERROR_OK;
+}
+
 static const struct command_registration target_command_handlers[] = {
 	{
 		.name = "targets",
@@ -5964,6 +5975,14 @@ static const struct command_registration target_command_handlers[] = {
 		.chain = target_subcommand_handlers,
 		.usage = "",
 	},
+	{
+		.name = "enable_rtos_riscv",
+		.handler = handle_enable_rtos_riscv_command,
+		.mode = COMMAND_CONFIG,
+		.usage = "enable_rtos_riscv",
+		.help = "Allow the use of `-rtos riscv` for just a little longer, "
+			"until it will be completely removed at the end of 2020."
+	},
 	COMMAND_REGISTRATION_DONE
 };