Add target_run_algorithm wrapper:

- replaces all calls to target->type->run_algorithm.
- add documentation in target_s to warn not to invoke callback directly.


git-svn-id: svn://svn.berlios.de/openocd/trunk@1961 b42882b7-edfa-0310-969c-e2dbd0fdcd60

14 files changed, 41 insertions, 15 deletions

diff --git a/src/flash/aduc702x.c b/src/flash/aduc702x.c
index 2a9c1c26..6268b1cd 100644
--- a/src/flash/aduc702x.c
+++ b/src/flash/aduc702x.c
@@ -288,7 +288,7 @@ static int aduc702x_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offse
 		buf_set_u32(reg_params[2].value, 0, 32, address);
 		buf_set_u32(reg_params[4].value, 0, 32, 0xFFFFF800);
 
-		if ((retval = target->type->run_algorithm(target, 0, NULL, 5, 
+		if ((retval = target_run_algorithm(target, 0, NULL, 5, 
                         reg_params, aduc702x_info->write_algorithm->address, 
                         aduc702x_info->write_algorithm->address + sizeof(aduc702x_flash_write_code) - 4, 
                         10000, &armv4_5_info)) != ERROR_OK)
diff --git a/src/flash/cfi.c b/src/flash/cfi.c
index ba6c7a80..432c8cc4 100644
--- a/src/flash/cfi.c
+++ b/src/flash/cfi.c
@@ -1227,7 +1227,7 @@ static int cfi_intel_write_block(struct flash_bank_s *bank, u8 *buffer, u32 addr
 		LOG_INFO("Write 0x%04x bytes to flash at 0x%08x", thisrun_count, address );
 
 		/* Execute algorithm, assume breakpoint for last instruction */
-		retval = target->type->run_algorithm(target, 0, NULL, 7, reg_params,
+		retval = target_run_algorithm(target, 0, NULL, 7, reg_params,
 			cfi_info->write_algorithm->address,
 			cfi_info->write_algorithm->address + target_code_size - sizeof(u32),
 			10000, /* 10s should be enough for max. 32k of data */
@@ -1510,7 +1510,7 @@ static int cfi_spansion_write_block(struct flash_bank_s *bank, u8 *buffer, u32 a
 		buf_set_u32(reg_params[8].value, 0, 32, flash_address(bank, 0, pri_ext->_unlock2));
 		buf_set_u32(reg_params[9].value, 0, 32, 0x55555555);
 
-		retval = target->type->run_algorithm(target, 0, NULL, 10, reg_params,
+		retval = target_run_algorithm(target, 0, NULL, 10, reg_params,
 						     cfi_info->write_algorithm->address,
 						     cfi_info->write_algorithm->address + ((24 * 4) - 4),
 						     10000, &armv4_5_info);
diff --git a/src/flash/ecos.c b/src/flash/ecos.c
index e1fa2d66..2d03edb9 100644
--- a/src/flash/ecos.c
+++ b/src/flash/ecos.c
@@ -245,7 +245,7 @@ static int runCode(ecosflash_flash_bank_t *info,
 	buf_set_u32(reg_params[2].value, 0, 32, r2);
 
 	int retval;
-	if ((retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params,
+	if ((retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
 			codeStart,
 			codeStop, timeout,
 			&armv4_5_info)) != ERROR_OK)
diff --git a/src/flash/lpc2000.c b/src/flash/lpc2000.c
index dbbc3748..c3299bcd 100644
--- a/src/flash/lpc2000.c
+++ b/src/flash/lpc2000.c
@@ -298,7 +298,7 @@ static int lpc2000_iap_call(flash_bank_t *bank, int code, u32 param_table[5], u3
 	init_reg_param(&reg_params[4], "lr_svc", 32, PARAM_OUT);
 	buf_set_u32(reg_params[4].value, 0, 32, lpc2000_info->iap_working_area->address + 0x4);
 
-	target->type->run_algorithm(target, 2, mem_params, 5, reg_params, lpc2000_info->iap_working_area->address, lpc2000_info->iap_working_area->address + 0x4, 10000, &armv4_5_info);
+	target_run_algorithm(target, 2, mem_params, 5, reg_params, lpc2000_info->iap_working_area->address, lpc2000_info->iap_working_area->address + 0x4, 10000, &armv4_5_info);
 
 	status_code = buf_get_u32(mem_params[1].value, 0, 32);
 	result_table[0] = target_buffer_get_u32(target, mem_params[1].value);
diff --git a/src/flash/orion_nand.c b/src/flash/orion_nand.c
index cf26568d..5ec1c25c 100644
--- a/src/flash/orion_nand.c
+++ b/src/flash/orion_nand.c
@@ -162,7 +162,7 @@ static int orion_nand_fast_block_write(struct nand_device_s *device, u8 *data, i
 	buf_set_u32(reg_params[1].value, 0, 32, target_buf);
 	buf_set_u32(reg_params[2].value, 0, 32, size);
 
-	retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params,
+	retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
 					hw->copy_area->address,
 					hw->copy_area->address + code_size - 4,
 					1000, &algo);
diff --git a/src/flash/pic32mx.c b/src/flash/pic32mx.c
index 2a5ce641..b45902cd 100644
--- a/src/flash/pic32mx.c
+++ b/src/flash/pic32mx.c
@@ -419,7 +419,7 @@ static int pic32mx_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offset
 		buf_set_u32(reg_params[1].value, 0, 32, address);
 		buf_set_u32(reg_params[2].value, 0, 32, buffer_size/4);
 
-		if ((retval = target->type->run_algorithm(target, 0, NULL, 4, reg_params, pic32mx_info->write_algorithm->address, \
+		if ((retval = target_run_algorithm(target, 0, NULL, 4, reg_params, pic32mx_info->write_algorithm->address, \
 				pic32mx_info->write_algorithm->address + (sizeof(pic32mx_flash_write_code) - 10), 10000, &armv7m_info)) != ERROR_OK)
 		{
 			LOG_ERROR("error executing pic32mx flash write algorithm");
diff --git a/src/flash/stellaris.c b/src/flash/stellaris.c
index 38ded4f1..001b0176 100644
--- a/src/flash/stellaris.c
+++ b/src/flash/stellaris.c
@@ -779,7 +779,7 @@ static int stellaris_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offs
 		buf_set_u32(reg_params[2].value, 0, 32, 4*thisrun_count);
 		LOG_INFO("Algorithm flash write %i words to 0x%x, %i remaining", thisrun_count, address, wcount);
 		LOG_DEBUG("Algorithm flash write %i words to 0x%x, %i remaining", thisrun_count, address, wcount);
-		if ((retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params, write_algorithm->address, write_algorithm->address + sizeof(stellaris_write_code)-10, 10000, &armv7m_info)) != ERROR_OK)
+		if ((retval = target_run_algorithm(target, 0, NULL, 3, reg_params, write_algorithm->address, write_algorithm->address + sizeof(stellaris_write_code)-10, 10000, &armv7m_info)) != ERROR_OK)
 		{
 			LOG_ERROR("error executing stellaris flash write algorithm");
 			retval = ERROR_FLASH_OPERATION_FAILED;
diff --git a/src/flash/stm32x.c b/src/flash/stm32x.c
index 2a3b764c..1f3460b1 100644
--- a/src/flash/stm32x.c
+++ b/src/flash/stm32x.c
@@ -554,7 +554,7 @@ static int stm32x_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offset,
 		buf_set_u32(reg_params[1].value, 0, 32, address);
 		buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
 		
-		if ((retval = target->type->run_algorithm(target, 0, NULL, 4, reg_params, stm32x_info->write_algorithm->address, \
+		if ((retval = target_run_algorithm(target, 0, NULL, 4, reg_params, stm32x_info->write_algorithm->address, \
 				stm32x_info->write_algorithm->address + (sizeof(stm32x_flash_write_code) - 10), 10000, &armv7m_info)) != ERROR_OK)
 		{
 			LOG_ERROR("error executing stm32x flash write algorithm");
diff --git a/src/flash/str7x.c b/src/flash/str7x.c
index a1cb9636..88f4f9eb 100644
--- a/src/flash/str7x.c
+++ b/src/flash/str7x.c
@@ -429,7 +429,7 @@ static int str7x_write_block(struct flash_bank_s *bank, u8 *buffer, u32 offset,
 		buf_set_u32(reg_params[3].value, 0, 32, thisrun_count);
 		buf_set_u32(reg_params[5].value, 0, 32, str7x_info->busy_bits);
 	
-		if ((retval = target->type->run_algorithm(target, 0, NULL, 6, reg_params, str7x_info->write_algorithm->address, str7x_info->write_algorithm->address + (19 * 4), 10000, &armv4_5_info)) != ERROR_OK)
+		if ((retval = target_run_algorithm(target, 0, NULL, 6, reg_params, str7x_info->write_algorithm->address, str7x_info->write_algorithm->address + (19 * 4), 10000, &armv4_5_info)) != ERROR_OK)
 		{
 			LOG_ERROR("error executing str7x flash write algorithm");
 			retval = ERROR_FLASH_OPERATION_FAILED;
diff --git a/src/flash/str9x.c b/src/flash/str9x.c
index 7de98b12..3566bf9c 100644
--- a/src/flash/str9x.c
+++ b/src/flash/str9x.c
@@ -463,7 +463,7 @@ static int str9x_write_block(struct flash_bank_s *bank,
 		buf_set_u32(reg_params[1].value, 0, 32, address);
 		buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
 
-		if ((retval = target->type->run_algorithm(target, 0, NULL, 4, reg_params, str9x_info->write_algorithm->address, str9x_info->write_algorithm->address + (18 * 4), 10000, &armv4_5_info)) != ERROR_OK)
+		if ((retval = target_run_algorithm(target, 0, NULL, 4, reg_params, str9x_info->write_algorithm->address, str9x_info->write_algorithm->address + (18 * 4), 10000, &armv4_5_info)) != ERROR_OK)
 		{
 			LOG_ERROR("error executing str9x flash write algorithm");
 			retval = ERROR_FLASH_OPERATION_FAILED;
diff --git a/src/target/arm7_9_common.c b/src/target/arm7_9_common.c
index 4db26e92..0d202d1a 100644
--- a/src/target/arm7_9_common.c
+++ b/src/target/arm7_9_common.c
@@ -2747,7 +2747,7 @@ int arm7_9_checksum_memory(struct target_s *target, u32 address, u32 count, u32*
 	buf_set_u32(reg_params[0].value, 0, 32, address);
 	buf_set_u32(reg_params[1].value, 0, 32, count);
 
-	if ((retval = target->type->run_algorithm(target, 0, NULL, 2, reg_params,
+	if ((retval = target_run_algorithm(target, 0, NULL, 2, reg_params,
 		crc_algorithm->address, crc_algorithm->address + (sizeof(arm7_9_crc_code) - 8), 20000, &armv4_5_info)) != ERROR_OK)
 	{
 		LOG_ERROR("error executing arm7_9 crc algorithm");
@@ -2812,7 +2812,7 @@ int arm7_9_blank_check_memory(struct target_s *target, u32 address, u32 count, u
 	init_reg_param(&reg_params[2], "r2", 32, PARAM_IN_OUT);
 	buf_set_u32(reg_params[2].value, 0, 32, 0xff);
 
-	if ((retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params,
+	if ((retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
 			erase_check_algorithm->address, erase_check_algorithm->address + (sizeof(erase_check_code) - 4), 10000, &armv4_5_info)) != ERROR_OK)
 	{
 		destroy_reg_param(&reg_params[0]);
diff --git a/src/target/armv7m.c b/src/target/armv7m.c
index a73e60ea..629ac463 100644
--- a/src/target/armv7m.c
+++ b/src/target/armv7m.c
@@ -613,7 +613,7 @@ int armv7m_checksum_memory(struct target_s *target, u32 address, u32 count, u32*
 	buf_set_u32(reg_params[0].value, 0, 32, address);
 	buf_set_u32(reg_params[1].value, 0, 32, count);
 
-	if ((retval = target->type->run_algorithm(target, 0, NULL, 2, reg_params,
+	if ((retval = target_run_algorithm(target, 0, NULL, 2, reg_params,
 		crc_algorithm->address, crc_algorithm->address + (sizeof(cortex_m3_crc_code)-6), 20000, &armv7m_info)) != ERROR_OK)
 	{
 		LOG_ERROR("error executing cortex_m3 crc algorithm");
@@ -674,7 +674,7 @@ int armv7m_blank_check_memory(struct target_s *target, u32 address, u32 count, u
 	init_reg_param(&reg_params[2], "r2", 32, PARAM_IN_OUT);
 	buf_set_u32(reg_params[2].value, 0, 32, 0xff);
 
-	if ((retval = target->type->run_algorithm(target, 0, NULL, 3, reg_params,
+	if ((retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
 			erase_check_algorithm->address, erase_check_algorithm->address + (sizeof(erase_check_code)-2), 10000, &armv7m_info)) != ERROR_OK)
 	{
 		destroy_reg_param(&reg_params[0]);
diff --git a/src/target/target.c b/src/target/target.c
index d5a40195..71eb9d2b 100644
--- a/src/target/target.c
+++ b/src/target/target.c
@@ -537,6 +537,17 @@ int target_write_memory(struct target_s *target,
 	return target->type->write_memory(target, address, size, count, buffer);
 }
 
+int target_run_algorithm(struct target_s *target,
+		int num_mem_params, mem_param_t *mem_params,
+		int num_reg_params, reg_param_t *reg_param,
+		u32 entry_point, u32 exit_point,
+		int timeout_ms, void *arch_info)
+{
+	return target->type->run_algorithm(target,
+			num_mem_params, mem_params, num_reg_params, reg_param,
+			entry_point, exit_point, timeout_ms, arch_info);
+}
+
 
 int target_init(struct command_context_s *cmd_ctx)
 {
diff --git a/src/target/target.h b/src/target/target.h
index 2214c06e..c319a25b 100644
--- a/src/target/target.h
+++ b/src/target/target.h
@@ -204,6 +204,10 @@ typedef struct target_type_s
 
 	/* target algorithm support */
 	int (*run_algorithm_imp)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
+	/**
+	 * Target algorithm support.  Do @b not call this method directly,
+	 * use target_run_algorithm() instead.
+	 */
 	int (*run_algorithm)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
 
 	int (*register_commands)(struct command_context_s *cmd_ctx);
@@ -380,6 +384,17 @@ extern int get_num_by_target(target_t *query_target);
 extern target_t *get_target(const char *id);
 
 /**
+ * Run an algorithm on the @a target given.
+ *
+ * This routine is a wrapper for target->type->run_algorithm.
+ */
+extern int target_run_algorithm(struct target_s *target,
+		int num_mem_params, mem_param_t *mem_params,
+		int num_reg_params, reg_param_t *reg_param,
+		u32 entry_point, u32 exit_point,
+		int timeout_ms, void *arch_info);
+
+/**
  * Read @count items of @a size bytes from the memory of @a target at
  * the @a address given.
  *