Move JTAG command handling implementation into its own source file.

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

3 files changed, 260 insertions, 223 deletions

diff --git a/src/jtag/Makefile.am b/src/jtag/Makefile.am
index e5825415..09d0685c 100644
--- a/src/jtag/Makefile.am
+++ b/src/jtag/Makefile.am
@@ -54,7 +54,7 @@ endif
 if MINIDRIVER
 DRIVERFILES =
 else
-DRIVERFILES = jtag_driver.c
+DRIVERFILES = jtag_driver.c commands.c
 endif
 
 if AT91RM9200
diff --git a/src/jtag/commands.c b/src/jtag/commands.c
new file mode 100644
index 00000000..c9c7cf7f
--- /dev/null
+++ b/src/jtag/commands.c
@@ -0,0 +1,259 @@
+/***************************************************************************
+ *   Copyright (C) 2005 by Dominic Rath                                    *
+ *   Dominic.Rath@gmx.de                                                   *
+ *                                                                         *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   oyvind.harboe@zylin.com                                               *
+ *                                                                         *
+ *   Copyright (C) 2009 SoftPLC Corporation                                *
+ *       http://softplc.com                                                *
+ *   dick@softplc.com                                                      *
+ *                                                                         *
+ *   Copyright (C) 2009 Zachary T Welch                                    *
+ *   zw@superlucidity.net                                                  *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include "commands.h"
+
+typedef struct cmd_queue_page_s
+{
+	void *address;
+	size_t used;
+	struct cmd_queue_page_s *next;
+} cmd_queue_page_t;
+
+#define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
+static cmd_queue_page_t *cmd_queue_pages = NULL;
+
+jtag_command_t *jtag_command_queue = NULL;
+static jtag_command_t **next_command_pointer = &jtag_command_queue;
+
+void jtag_queue_command(jtag_command_t * cmd)
+{
+	// this command goes on the end, so ensure the queue terminates
+	cmd->next = NULL;
+
+	jtag_command_t **last_cmd = next_command_pointer;
+	assert(NULL != last_cmd);
+	assert(NULL == *last_cmd);
+	*last_cmd = cmd;
+
+	// store location where the next command pointer will be stored
+	next_command_pointer = &cmd->next;
+}
+
+void* cmd_queue_alloc(size_t size)
+{
+	cmd_queue_page_t **p_page = &cmd_queue_pages;
+	int offset;
+	u8 *t;
+
+	/*
+	 * WARNING:
+	 *    We align/round the *SIZE* per below
+	 *    so that all pointers returned by
+	 *    this function are reasonably well
+	 *    aligned.
+	 *
+	 * If we did not, then an "odd-length" request would cause the
+	 * *next* allocation to be at an *odd* address, and because
+	 * this function has the same type of api as malloc() - we
+	 * must also return pointers that have the same type of
+	 * alignment.
+	 *
+	 * What I do not/have is a reasonable portable means
+	 * to align by...
+	 *
+	 * The solution here, is based on these suggestions.
+	 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
+	 *
+	 */
+	union worse_case_align {
+		int i;
+		long l;
+		float f;
+		void *v;
+	};
+#define ALIGN_SIZE  (sizeof(union worse_case_align))
+
+	/* The alignment process. */
+	size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
+	/* Done... */
+
+	if (*p_page)
+	{
+		while ((*p_page)->next)
+			p_page = &((*p_page)->next);
+		if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
+			p_page = &((*p_page)->next);
+	}
+
+	if (!*p_page)
+	{
+		*p_page = malloc(sizeof(cmd_queue_page_t));
+		(*p_page)->used = 0;
+		(*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
+		(*p_page)->next = NULL;
+	}
+
+	offset = (*p_page)->used;
+	(*p_page)->used += size;
+
+	t=(u8 *)((*p_page)->address);
+	return t + offset;
+}
+
+void cmd_queue_free(void)
+{
+	cmd_queue_page_t *page = cmd_queue_pages;
+
+	while (page)
+	{
+		cmd_queue_page_t *last = page;
+		free(page->address);
+		page = page->next;
+		free(last);
+	}
+
+	cmd_queue_pages = NULL;
+}
+
+void jtag_command_queue_reset(void)
+{
+	cmd_queue_free();
+
+	jtag_command_queue = NULL;
+	next_command_pointer = &jtag_command_queue;
+}
+
+enum scan_type jtag_scan_type(const scan_command_t *cmd)
+{
+	int i;
+	int type = 0;
+
+	for (i = 0; i < cmd->num_fields; i++)
+	{
+		if (cmd->fields[i].in_value)
+			type |= SCAN_IN;
+		if (cmd->fields[i].out_value)
+			type |= SCAN_OUT;
+	}
+
+	return type;
+}
+
+int jtag_scan_size(const scan_command_t *cmd)
+{
+	int bit_count = 0;
+	int i;
+
+	/* count bits in scan command */
+	for (i = 0; i < cmd->num_fields; i++)
+	{
+		bit_count += cmd->fields[i].num_bits;
+	}
+
+	return bit_count;
+}
+
+int jtag_build_buffer(const scan_command_t *cmd, u8 **buffer)
+{
+	int bit_count = 0;
+	int i;
+
+	bit_count = jtag_scan_size(cmd);
+	*buffer = calloc(1,CEIL(bit_count, 8));
+
+	bit_count = 0;
+
+#ifdef _DEBUG_JTAG_IO_
+	LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
+#endif
+
+	for (i = 0; i < cmd->num_fields; i++)
+	{
+		if (cmd->fields[i].out_value)
+		{
+#ifdef _DEBUG_JTAG_IO_
+			char* char_buf = buf_to_str(cmd->fields[i].out_value, (cmd->fields[i].num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : cmd->fields[i].num_bits, 16);
+#endif
+			buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
+#ifdef _DEBUG_JTAG_IO_
+			LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
+			free(char_buf);
+#endif
+		}
+		else
+		{
+#ifdef _DEBUG_JTAG_IO_
+			LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
+#endif
+		}
+
+		bit_count += cmd->fields[i].num_bits;
+	}
+
+#ifdef _DEBUG_JTAG_IO_
+	//LOG_DEBUG("bit_count totalling: %i",  bit_count );
+#endif
+
+	return bit_count;
+}
+
+int jtag_read_buffer(u8 *buffer, const scan_command_t *cmd)
+{
+	int i;
+	int bit_count = 0;
+	int retval;
+
+	/* we return ERROR_OK, unless a check fails, or a handler reports a problem */
+	retval = ERROR_OK;
+
+	for (i = 0; i < cmd->num_fields; i++)
+	{
+		/* if neither in_value nor in_handler
+		 * are specified we don't have to examine this field
+		 */
+		if (cmd->fields[i].in_value)
+		{
+			int num_bits = cmd->fields[i].num_bits;
+			u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
+
+#ifdef _DEBUG_JTAG_IO_
+			char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
+			LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
+			free(char_buf);
+#endif
+
+			if (cmd->fields[i].in_value)
+			{
+				buf_cpy(captured, cmd->fields[i].in_value, num_bits);
+			}
+
+			free(captured);
+		}
+		bit_count += cmd->fields[i].num_bits;
+	}
+
+	return retval;
+}
+
+
diff --git a/src/jtag/jtag.c b/src/jtag/jtag.c
index 8eef69e8..a74c0ad4 100644
--- a/src/jtag/jtag.c
+++ b/src/jtag/jtag.c
@@ -47,16 +47,6 @@ static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const s
 */
 int jtag_error=ERROR_OK;
 
-typedef struct cmd_queue_page_s
-{
-	void *address;
-	size_t used;
-	struct cmd_queue_page_s *next;
-} cmd_queue_page_t;
-
-#define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
-static cmd_queue_page_t *cmd_queue_pages = NULL;
-
 char* jtag_event_strings[] =
 {
 	"JTAG controller reset (RESET or TRST)"
@@ -72,8 +62,6 @@ const Jim_Nvp nvp_jtag_tap_event[] = {
 int jtag_trst = 0;
 int jtag_srst = 0;
 
-jtag_command_t *jtag_command_queue = NULL;
-static jtag_command_t **next_command_pointer = &jtag_command_queue;
 static jtag_tap_t *jtag_all_taps = NULL;
 
 enum reset_types jtag_reset_config = RESET_NONE;
@@ -397,104 +385,6 @@ int jtag_call_event_callbacks(enum jtag_event event)
 	return ERROR_OK;
 }
 
-void jtag_queue_command(jtag_command_t * cmd)
-{
-	// this command goes on the end, so ensure the queue terminates
-	cmd->next = NULL;
-
-	jtag_command_t **last_cmd = next_command_pointer;
-	assert(NULL != last_cmd);
-	assert(NULL == *last_cmd);
-	*last_cmd = cmd;
-
-	// store location where the next command pointer will be stored
-	next_command_pointer = &cmd->next;
-}
-
-void* cmd_queue_alloc(size_t size)
-{
-	cmd_queue_page_t **p_page = &cmd_queue_pages;
-	int offset;
-	u8 *t;
-
-	/*
-	 * WARNING:
-	 *    We align/round the *SIZE* per below
-	 *    so that all pointers returned by
-	 *    this function are reasonably well
-	 *    aligned.
-	 *
-	 * If we did not, then an "odd-length" request would cause the
-	 * *next* allocation to be at an *odd* address, and because
-	 * this function has the same type of api as malloc() - we
-	 * must also return pointers that have the same type of
-	 * alignment.
-	 *
-	 * What I do not/have is a reasonable portable means
-	 * to align by...
-	 *
-	 * The solution here, is based on these suggestions.
-	 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
-	 *
-	 */
-	union worse_case_align {
-		int i;
-		long l;
-		float f;
-		void *v;
-	};
-#define ALIGN_SIZE  (sizeof(union worse_case_align))
-
-	/* The alignment process. */
-	size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
-	/* Done... */
-
-	if (*p_page)
-	{
-		while ((*p_page)->next)
-			p_page = &((*p_page)->next);
-		if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
-			p_page = &((*p_page)->next);
-	}
-
-	if (!*p_page)
-	{
-		*p_page = malloc(sizeof(cmd_queue_page_t));
-		(*p_page)->used = 0;
-		(*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
-		(*p_page)->next = NULL;
-	}
-
-	offset = (*p_page)->used;
-	(*p_page)->used += size;
-
-	t=(u8 *)((*p_page)->address);
-	return t + offset;
-}
-
-void cmd_queue_free(void)
-{
-	cmd_queue_page_t *page = cmd_queue_pages;
-
-	while (page)
-	{
-		cmd_queue_page_t *last = page;
-		free(page->address);
-		page = page->next;
-		free(last);
-	}
-
-	cmd_queue_pages = NULL;
-}
-
-void jtag_command_queue_reset(void)
-{
-	cmd_queue_free();
-
-	jtag_command_queue = NULL;
-	next_command_pointer = &jtag_command_queue;
-}
-
 static void jtag_prelude1(void)
 {
 	if (jtag_trst == 1)
@@ -908,102 +798,6 @@ void jtag_add_sleep(u32 us)
 	return;
 }
 
-int jtag_scan_size(const scan_command_t *cmd)
-{
-	int bit_count = 0;
-	int i;
-
-	/* count bits in scan command */
-	for (i = 0; i < cmd->num_fields; i++)
-	{
-		bit_count += cmd->fields[i].num_bits;
-	}
-
-	return bit_count;
-}
-
-int jtag_build_buffer(const scan_command_t *cmd, u8 **buffer)
-{
-	int bit_count = 0;
-	int i;
-
-	bit_count = jtag_scan_size(cmd);
-	*buffer = calloc(1,CEIL(bit_count, 8));
-
-	bit_count = 0;
-
-#ifdef _DEBUG_JTAG_IO_
-	LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
-#endif
-
-	for (i = 0; i < cmd->num_fields; i++)
-	{
-		if (cmd->fields[i].out_value)
-		{
-#ifdef _DEBUG_JTAG_IO_
-			char* char_buf = buf_to_str(cmd->fields[i].out_value, (cmd->fields[i].num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : cmd->fields[i].num_bits, 16);
-#endif
-			buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
-#ifdef _DEBUG_JTAG_IO_
-			LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
-			free(char_buf);
-#endif
-		}
-		else
-		{
-#ifdef _DEBUG_JTAG_IO_
-			LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
-#endif
-		}
-
-		bit_count += cmd->fields[i].num_bits;
-	}
-
-#ifdef _DEBUG_JTAG_IO_
-	//LOG_DEBUG("bit_count totalling: %i",  bit_count );
-#endif
-
-	return bit_count;
-}
-
-int jtag_read_buffer(u8 *buffer, const scan_command_t *cmd)
-{
-	int i;
-	int bit_count = 0;
-	int retval;
-
-	/* we return ERROR_OK, unless a check fails, or a handler reports a problem */
-	retval = ERROR_OK;
-
-	for (i = 0; i < cmd->num_fields; i++)
-	{
-		/* if neither in_value nor in_handler
-		 * are specified we don't have to examine this field
-		 */
-		if (cmd->fields[i].in_value)
-		{
-			int num_bits = cmd->fields[i].num_bits;
-			u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
-
-#ifdef _DEBUG_JTAG_IO_
-			char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
-			LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
-			free(char_buf);
-#endif
-
-			if (cmd->fields[i].in_value)
-			{
-				buf_cpy(captured, cmd->fields[i].in_value, num_bits);
-			}
-
-			free(captured);
-		}
-		bit_count += cmd->fields[i].num_bits;
-	}
-
-	return retval;
-}
-
 static const char *jtag_tap_name(const jtag_tap_t *tap)
 {
 	return (tap == NULL) ? "(unknown)" : tap->dotted_name;
@@ -1076,22 +870,6 @@ void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
 
 
 
-enum scan_type jtag_scan_type(const scan_command_t *cmd)
-{
-	int i;
-	int type = 0;
-
-	for (i = 0; i < cmd->num_fields; i++)
-	{
-		if (cmd->fields[i].in_value)
-			type |= SCAN_IN;
-		if (cmd->fields[i].out_value)
-			type |= SCAN_OUT;
-	}
-
-	return type;
-}
-
 int default_interface_jtag_execute_queue(void)
 {
 	if (NULL == jtag)