target/riscv: deprecate `riscv set_reset_timeout_sec`

Change-Id: I46bf3e4dab2a99c97b7ab133a85c13332365f9b7
Signed-off-by: Evgeniy Naydanov <evgeniy.naydanov@syntacore.com>

4 files changed, 41 insertions, 72 deletions

diff --git a/src/target/riscv/riscv-011.c b/src/target/riscv/riscv-011.c
index cd30a52..0715de5 100644
--- a/src/target/riscv/riscv-011.c
+++ b/src/target/riscv/riscv-011.c
@@ -741,7 +741,7 @@ static int wait_for_debugint_clear(struct target *target, bool ignore_first)
 
 		if (!bits.interrupt)
 			return ERROR_OK;
-		if (time(NULL) - start > riscv_command_timeout_sec) {
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_ERROR("Timed out waiting for debug int to clear."
 				  "Increase timeout with riscv set_command_timeout_sec.");
 			return ERROR_FAIL;
@@ -1025,7 +1025,7 @@ static int wait_for_state(struct target *target, enum target_state state)
 			return result;
 		if (target->state == state)
 			return ERROR_OK;
-		if (time(NULL) - start > riscv_command_timeout_sec) {
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_ERROR("Timed out waiting for state %d. "
 				  "Increase timeout with riscv set_command_timeout_sec.", state);
 			return ERROR_FAIL;
@@ -1186,7 +1186,7 @@ static int full_step(struct target *target, bool announce)
 			return result;
 		if (target->state != TARGET_DEBUG_RUNNING)
 			break;
-		if (time(NULL) - start > riscv_command_timeout_sec) {
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_ERROR("Timed out waiting for step to complete."
 					"Increase timeout with riscv set_command_timeout_sec");
 			return ERROR_FAIL;
@@ -2344,10 +2344,10 @@ static int wait_for_authbusy(struct target *target)
 		uint32_t dminfo = dbus_read(target, DMINFO);
 		if (!get_field(dminfo, DMINFO_AUTHBUSY))
 			break;
-		if (time(NULL) - start > riscv_command_timeout_sec) {
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_ERROR("Timed out after %ds waiting for authbusy to go low (dminfo=0x%x). "
 					"Increase the timeout with riscv set_command_timeout_sec.",
-					riscv_command_timeout_sec,
+					riscv_get_command_timeout_sec(),
 					dminfo);
 			return ERROR_FAIL;
 		}
diff --git a/src/target/riscv/riscv-013.c b/src/target/riscv/riscv-013.c
index 07b6da0..914a7f2 100644
--- a/src/target/riscv/riscv-013.c
+++ b/src/target/riscv/riscv-013.c
@@ -695,12 +695,12 @@ static int dmi_op(struct target *target, uint32_t *data_in,
 		uint32_t data_out, bool exec, bool ensure_success)
 {
 	int result = dmi_op_timeout(target, data_in, dmi_busy_encountered, op,
-			address, data_out, riscv_command_timeout_sec, exec, ensure_success);
+			address, data_out, riscv_get_command_timeout_sec(), exec, ensure_success);
 	if (result == ERROR_TIMEOUT_REACHED) {
 		LOG_TARGET_ERROR(target, "DMI operation didn't complete in %d seconds. The target is "
 				"either really slow or broken. You could increase the "
 				"timeout with riscv set_command_timeout_sec.",
-				riscv_command_timeout_sec);
+				riscv_get_command_timeout_sec());
 		return ERROR_FAIL;
 	}
 	return result;
@@ -731,17 +731,6 @@ static uint32_t riscv013_get_dmi_address(const struct target *target, uint32_t a
 	return address + base;
 }
 
-static int dm_op_timeout(struct target *target, uint32_t *data_in,
-		bool *dmi_busy_encountered, int op, uint32_t address,
-		uint32_t data_out, int timeout_sec, bool exec, bool ensure_success)
-{
-	dm013_info_t *dm = get_dm(target);
-	if (!dm)
-		return ERROR_FAIL;
-	return dmi_op_timeout(target, data_in, dmi_busy_encountered, op, address + dm->base,
-		data_out, timeout_sec, exec, ensure_success);
-}
-
 static int dm_op(struct target *target, uint32_t *data_in,
 		bool *dmi_busy_encountered, int op, uint32_t address,
 		uint32_t data_out, bool exec, bool ensure_success)
@@ -805,11 +794,10 @@ static bool check_dbgbase_exists(struct target *target)
 	return false;
 }
 
-static int dmstatus_read_timeout(struct target *target, uint32_t *dmstatus,
-		bool authenticated, unsigned timeout_sec)
+static int dmstatus_read(struct target *target, uint32_t *dmstatus,
+		bool authenticated)
 {
-	int result = dm_op_timeout(target, dmstatus, NULL, DMI_OP_READ,
-			DM_DMSTATUS, 0, timeout_sec, false, true);
+	int result = dm_read(target, dmstatus, DM_DMSTATUS);
 	if (result != ERROR_OK)
 		return result;
 	int dmstatus_version = get_field(*dmstatus, DM_DMSTATUS_VERSION);
@@ -827,19 +815,6 @@ static int dmstatus_read_timeout(struct target *target, uint32_t *dmstatus,
 	return ERROR_OK;
 }
 
-static int dmstatus_read(struct target *target, uint32_t *dmstatus,
-		bool authenticated)
-{
-	int result = dmstatus_read_timeout(target, dmstatus, authenticated,
-			riscv_command_timeout_sec);
-	if (result == ERROR_TIMEOUT_REACHED)
-		LOG_TARGET_ERROR(target, "DMSTATUS read didn't complete in %d seconds. The target is "
-					 "either really slow or broken. You could increase the "
-					 "timeout with `riscv set_command_timeout_sec`.",
-				 riscv_command_timeout_sec);
-	return result;
-}
-
 static int increase_ac_busy_delay(struct target *target)
 {
 	riscv013_info_t *info = get_info(target);
@@ -890,12 +865,12 @@ static int wait_for_idle(struct target *target, uint32_t *abstractcs)
 			dm->abstract_cmd_maybe_busy = false;
 			return ERROR_OK;
 		}
-	} while ((time(NULL) - start) < riscv_command_timeout_sec);
+	} while ((time(NULL) - start) < riscv_get_command_timeout_sec());
 
 	LOG_TARGET_ERROR(target,
 		"Timed out after %ds waiting for busy to go low (abstractcs=0x%" PRIx32 "). "
 		"Increase the timeout with riscv set_command_timeout_sec.",
-		riscv_command_timeout_sec,
+		riscv_get_command_timeout_sec(),
 		*abstractcs);
 
 	if (!dm->abstract_cmd_maybe_busy)
@@ -1898,10 +1873,10 @@ static int wait_for_authbusy(struct target *target, uint32_t *dmstatus)
 			*dmstatus = value;
 		if (!get_field(value, DM_DMSTATUS_AUTHBUSY))
 			break;
-		if (time(NULL) - start > riscv_command_timeout_sec) {
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_TARGET_ERROR(target, "Timed out after %ds waiting for authbusy to go low (dmstatus=0x%x). "
 					"Increase the timeout with riscv set_command_timeout_sec.",
-					riscv_command_timeout_sec,
+					riscv_get_command_timeout_sec(),
 					value);
 			return ERROR_FAIL;
 		}
@@ -2091,11 +2066,10 @@ static int reset_dm(struct target *target)
 			if (result != ERROR_OK)
 				return result;
 
-			if (time(NULL) - start > riscv_reset_timeout_sec) {
-				/* TODO: Introduce a separate timeout for this. */
+			if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 				LOG_TARGET_ERROR(target, "DM didn't acknowledge reset in %d s. "
-						"Increase the timeout with 'riscv set_reset_timeout_sec'.",
-						riscv_reset_timeout_sec);
+						"Increase the timeout with 'riscv set_command_timeout_sec'.",
+						riscv_get_command_timeout_sec());
 				return ERROR_TIMEOUT_REACHED;
 			}
 		} while (get_field32(dmcontrol, DM_DMCONTROL_DMACTIVE));
@@ -2114,11 +2088,10 @@ static int reset_dm(struct target *target)
 		if (result != ERROR_OK)
 			return result;
 
-		if (time(NULL) - start > riscv_reset_timeout_sec) {
-			/* TODO: Introduce a separate timeout for this. */
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_TARGET_ERROR(target, "Debug Module did not become active in %d s. "
-					"Increase the timeout with 'riscv set_reset_timeout_sec'.",
-					riscv_reset_timeout_sec);
+					"Increase the timeout with 'riscv set_command_timeout_sec'.",
+					riscv_get_command_timeout_sec());
 			return ERROR_TIMEOUT_REACHED;
 		}
 	} while (!get_field32(dmcontrol, DM_DMCONTROL_DMACTIVE));
@@ -2810,7 +2783,7 @@ static int batch_run_timeout(struct target *target, struct riscv_batch *batch)
 		result = increase_dmi_busy_delay(target);
 		if (result != ERROR_OK)
 			return result;
-	} while (time(NULL) - start < riscv_command_timeout_sec);
+	} while (time(NULL) - start < riscv_get_command_timeout_sec());
 
 	assert(result == ERROR_OK);
 	assert(riscv_batch_was_batch_busy(batch));
@@ -2825,7 +2798,7 @@ static int batch_run_timeout(struct target *target, struct riscv_batch *batch)
 	LOG_TARGET_ERROR(target, "DMI operation didn't complete in %d seconds. "
 			"The target is either really slow or broken. You could increase "
 			"the timeout with riscv set_command_timeout_sec.",
-			riscv_command_timeout_sec);
+			riscv_get_command_timeout_sec());
 	return ERROR_TIMEOUT_REACHED;
 }
 
@@ -3225,21 +3198,15 @@ static int deassert_reset(struct target *target)
 	time_t start = time(NULL);
 	LOG_TARGET_DEBUG(target, "Waiting for hart to come out of reset.");
 	do {
-		result = dmstatus_read_timeout(target, &dmstatus, true,
-				riscv_reset_timeout_sec);
-		if (result == ERROR_TIMEOUT_REACHED)
-			LOG_TARGET_ERROR(target, "Hart didn't complete a DMI read coming "
-					"out of reset in %ds; Increase the timeout with riscv "
-					"set_reset_timeout_sec.",
-					riscv_reset_timeout_sec);
+		result = dmstatus_read(target, &dmstatus, true);
 		if (result != ERROR_OK)
 			return result;
 
-		if (time(NULL) - start > riscv_reset_timeout_sec) {
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_TARGET_ERROR(target, "Hart didn't leave reset in %ds; "
 					"dmstatus=0x%x (allunavail=%s, allhavereset=%s); "
-					"Increase the timeout with riscv set_reset_timeout_sec.",
-					riscv_reset_timeout_sec, dmstatus,
+					"Increase the timeout with riscv set_command_timeout_sec.",
+					riscv_get_command_timeout_sec(), dmstatus,
 					get_field(dmstatus, DM_DMSTATUS_ALLUNAVAIL) ? "true" : "false",
 					get_field(dmstatus, DM_DMSTATUS_ALLHAVERESET) ? "true" : "false");
 			return ERROR_TIMEOUT_REACHED;
@@ -3425,10 +3392,10 @@ static int read_sbcs_nonbusy(struct target *target, uint32_t *sbcs)
 			return ERROR_FAIL;
 		if (!get_field(*sbcs, DM_SBCS_SBBUSY))
 			return ERROR_OK;
-		if (time(NULL) - start > riscv_command_timeout_sec) {
+		if (time(NULL) - start > riscv_get_command_timeout_sec()) {
 			LOG_TARGET_ERROR(target, "Timed out after %ds waiting for sbbusy to go low (sbcs=0x%x). "
 					"Increase the timeout with riscv set_command_timeout_sec.",
-					riscv_command_timeout_sec, *sbcs);
+					riscv_get_command_timeout_sec(), *sbcs);
 			return ERROR_FAIL;
 		}
 	}
diff --git a/src/target/riscv/riscv.c b/src/target/riscv/riscv.c
index 9c4796d..a57c709 100644
--- a/src/target/riscv/riscv.c
+++ b/src/target/riscv/riscv.c
@@ -140,10 +140,15 @@ struct tdata1_cache {
 };
 
 /* Wall-clock timeout for a command/access. Settable via RISC-V Target commands.*/
-int riscv_command_timeout_sec = DEFAULT_COMMAND_TIMEOUT_SEC;
+static int riscv_command_timeout_sec_value = DEFAULT_COMMAND_TIMEOUT_SEC;
 
-/* Wall-clock timeout after reset. Settable via RISC-V Target commands.*/
-int riscv_reset_timeout_sec = DEFAULT_RESET_TIMEOUT_SEC;
+/* DEPRECATED Wall-clock timeout after reset. Settable via RISC-V Target commands.*/
+static int riscv_reset_timeout_sec = DEFAULT_COMMAND_TIMEOUT_SEC;
+
+int riscv_get_command_timeout_sec(void)
+{
+	return MAX(riscv_command_timeout_sec_value, riscv_reset_timeout_sec);
+}
 
 static bool riscv_enable_virt2phys = true;
 
@@ -3853,13 +3858,14 @@ COMMAND_HANDLER(riscv_set_command_timeout_sec)
 		return ERROR_FAIL;
 	}
 
-	riscv_command_timeout_sec = timeout;
+	riscv_command_timeout_sec_value = timeout;
 
 	return ERROR_OK;
 }
 
 COMMAND_HANDLER(riscv_set_reset_timeout_sec)
 {
+	LOG_WARNING("The command 'riscv set_reset_timeout_sec' is deprecated! Please, use 'riscv set_command_timeout_sec'.");
 	if (CMD_ARGC != 1) {
 		LOG_ERROR("Command takes exactly 1 parameter.");
 		return ERROR_COMMAND_SYNTAX_ERROR;
@@ -5066,7 +5072,7 @@ static const struct command_registration riscv_exec_command_handlers[] = {
 		.handler = riscv_set_reset_timeout_sec,
 		.mode = COMMAND_ANY,
 		.usage = "[sec]",
-		.help = "Set the wall-clock timeout (in seconds) after reset is deasserted"
+		.help = "DEPRECATED. Use 'riscv set_command_timeout_sec' instead."
 	},
 	{
 		.name = "set_mem_access",
diff --git a/src/target/riscv/riscv.h b/src/target/riscv/riscv.h
index c27e931..5b75bf6 100644
--- a/src/target/riscv/riscv.h
+++ b/src/target/riscv/riscv.h
@@ -22,8 +22,7 @@ struct riscv_program;
 #define RISCV_MAX_HWBPS 16
 #define RISCV_MAX_DMS 100
 
-#define DEFAULT_COMMAND_TIMEOUT_SEC		2
-#define DEFAULT_RESET_TIMEOUT_SEC		30
+#define DEFAULT_COMMAND_TIMEOUT_SEC 5
 
 #define RISCV_SATP_MODE(xlen)  ((xlen) == 32 ? SATP32_MODE : SATP64_MODE)
 #define RISCV_SATP_PPN(xlen)  ((xlen) == 32 ? SATP32_PPN : SATP64_PPN)
@@ -340,10 +339,7 @@ typedef struct {
 } virt2phys_info_t;
 
 /* Wall-clock timeout for a command/access. Settable via RISC-V Target commands.*/
-extern int riscv_command_timeout_sec;
-
-/* Wall-clock timeout after reset. Settable via RISC-V Target commands.*/
-extern int riscv_reset_timeout_sec;
+int riscv_get_command_timeout_sec(void);
 
 extern bool riscv_enable_virtual;