#endif
#include "xsvf.h"
-
#include "jtag.h"
-#include "command.h"
-#include "log.h"
-
-#include <stdlib.h>
-#include <unistd.h>
-#include <sys/types.h>
-#include <sys/stat.h>
-#include <fcntl.h>
-#include <string.h>
-
-#include <sys/time.h>
-#include <time.h>
/* XSVF commands, from appendix B of xapp503.pdf */
}
-/* xsvf has it's own definition of a statemove. This needs
- * to be handled according to the xsvf spec, which has nothing
- * to do with the JTAG spec or OpenOCD as such.
- *
- * Implemented via jtag_add_pathmove().
+/**
+ * Function xsvf_add_statemove
+ * moves from the current state to the goal \a state. This needs
+ * to be handled according to the xsvf spec, see the XSTATE command
+ * description.
*/
-static void xsvf_add_statemove(tap_state_t state)
+static int xsvf_add_statemove(tap_state_t goal_state)
{
- tap_state_t moves[7]; /* max # of transitions */
- tap_state_t curstate = cmd_queue_cur_state;
+ int retval = ERROR_OK;
+
+ tap_state_t moves[8];
+ tap_state_t cur_state = cmd_queue_cur_state;
int i;
+ int tms_bits;
+ int tms_count;
- u8 move = tap_get_tms_path(cmd_queue_cur_state, state);
+ LOG_DEBUG( "cur_state=%s goal_state=%s",
+ tap_state_name(cur_state),
+ tap_state_name(goal_state) );
+
+
+ /* From the XSVF spec, pertaining to XSTATE:
+
+ For special states known as stable states (Test-Logic-Reset,
+ Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
+ predefined TAP state paths when the starting state is a stable state and
+ when the XSTATE specifies a new stable state (see the STATE command in
+ the [Ref 5] for the TAP state paths between stable states). For
+ non-stable states, XSTATE should specify a state that is only one TAP
+ state transition distance from the current TAP state to avoid undefined
+ TAP state paths. A sequence of multiple XSTATE commands can be issued to
+ transition the TAP through a specific state path.
+ */
- if (state != TAP_RESET && state==cmd_queue_cur_state)
- return;
+ if (goal_state==cur_state )
+ ; /* nothing to do */
- if(state==TAP_RESET)
+ else if( goal_state==TAP_RESET )
{
jtag_add_tlr();
- return;
}
- for (i=0; i<7; i++)
+ else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
{
- int j = (move >> i) & 1;
- if (j)
- {
- curstate = tap_state_transition(curstate, true);
- }
- else
+ /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
+ spec, then this code is not fully conformant to the xsvf spec. This
+ puts a burden on tap_get_tms_path() function from the xsvf spec.
+ If in doubt, you should confirm that that burden is being met.
+ */
+
+ tms_bits = tap_get_tms_path(cur_state, goal_state);
+ tms_count = tap_get_tms_path_len(cur_state, goal_state);
+
+ assert( (unsigned) tms_count < DIM(moves) );
+
+ for (i=0; i<tms_count; i++, tms_bits>>=1)
{
- curstate = tap_state_transition(curstate, false);
+ bool bit = tms_bits & 1;
+
+ cur_state = tap_state_transition(cur_state, bit);
+ moves[i] = cur_state;
}
- moves[i] = curstate;
+
+ jtag_add_pathmove(tms_count, moves);
}
- jtag_add_pathmove(7, moves);
+ /* else state must be immediately reachable in one clock cycle, and does not
+ need to be a stable state.
+ */
+ else if( tap_state_transition(cur_state, true) == goal_state
+ || tap_state_transition(cur_state, false) == goal_state )
+ {
+ /* move a single state */
+ moves[0] = goal_state;
+ jtag_add_pathmove( 1, moves );
+ }
+
+ else
+ {
+ retval = ERROR_FAIL;
+ }
+
+ return retval;
}
+
int xsvf_register_commands(struct command_context_s *cmd_ctx)
{
register_command(cmd_ctx, NULL, "xsvf", handle_xsvf_command,
}
-static int xsvf_read_xstates(int fd, tap_state_t *path, int max_path, int *path_len)
-{
- char c;
- u8 uc;
-
- while ((read(fd, &c, 1) > 0) && (c == XSTATE))
- {
- tap_state_t mystate;
-
- if (*path_len > max_path)
- {
- LOG_WARNING("XSTATE path longer than max_path");
- break;
- }
- if (read(fd, &uc, 1) < 0)
- {
- return ERROR_XSVF_EOF;
- }
-
- mystate = xsvf_to_tap(uc);
-
- LOG_DEBUG("XSTATE %02X %s", uc, tap_state_name(mystate) );
-
- path[(*path_len)++] = mystate;
- }
-
- lseek(fd, -1, SEEK_CUR);
-
- return ERROR_OK;
-}
-
-
static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
u8 *dr_out_buf = NULL; /* from host to device (TDI) */
TAP_IDLE,
};
- jtag_add_pathmove( sizeof(exception_path)/sizeof(exception_path[0]), exception_path);
+ jtag_add_pathmove( DIM(exception_path), exception_path );
if (verbose)
LOG_USER("%s mismatch, xsdrsize=%d retry=%d", op_name, xsdrsize, attempt);
field.tap = tap;
field.num_bits = xsdrsize;
field.out_value = dr_out_buf;
- field.out_mask = NULL;
- field.in_value = NULL;
-
- jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL);
+ field.in_value = calloc(CEIL(field.num_bits, 8), 1);
if (tap == NULL)
jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
else
jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
+ jtag_check_value_mask(&field, dr_in_buf, dr_in_mask);
+
+ free(field.in_value);
+
+
/* LOG_DEBUG("FLUSHING QUEUE"); */
result = jtag_execute_queue();
if (result == ERROR_OK)
case XSTATE:
{
tap_state_t mystate;
- tap_state_t* path;
- int path_len;
+ u8 uc;
if (read(xsvf_fd, &uc, 1) < 0)
{
LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate) );
- path = calloc(XSTATE_MAX_PATH, 4);
- path_len = 1;
+ /* there is no need for the lookahead code that was here since we
+ queue up the jtag commands anyway. This is a simple way to handle
+ the XSTATE.
+ */
- path[0] = mystate;
- if (xsvf_read_xstates(xsvf_fd, path, XSTATE_MAX_PATH, &path_len) != ERROR_OK)
- do_abort = 1;
- else
+ if( xsvf_add_statemove( mystate ) != ERROR_OK )
{
- int i,lasti;
-
- /* here the trick is that jtag_add_pathmove() must end in a stable
- * state, so we must only invoke jtag_add_tlr() when we absolutely
- * have to
- */
- for(i=0,lasti=0; i<path_len; i++)
- {
- if(path[i]==TAP_RESET)
- {
- if(i>lasti)
- {
- jtag_add_pathmove(i-lasti,path+lasti);
- }
- lasti=i+1;
- jtag_add_tlr();
- }
- }
- if(i>=lasti)
- {
- jtag_add_pathmove(i-lasti, path+lasti);
- }
+ /* For special states known as stable states
+ (Test-Logic-Reset, Run-Test/Idle, Pause-DR, Pause- IR),
+ an XSVF interpreter follows predefined TAP state paths
+ when the starting state is a stable state and when the
+ XSTATE specifies a new stable state (see the STATE
+ command in the [Ref 5] for the TAP state paths between
+ stable states). For non-stable states, XSTATE should
+ specify a state that is only one TAP state transition
+ distance from the current TAP state to avoid undefined
+ TAP state paths. A sequence of multiple XSTATE commands
+ can be issued to transition the TAP through a specific
+ state path.
+ */
+
+ LOG_ERROR("XSTATE %s is not reachable from current state %s in one clock cycle",
+ tap_state_name(mystate),
+ tap_state_name(cmd_queue_cur_state)
+ );
}
- free(path);
}
break;
field.tap = tap;
field.num_bits = bitcount;
field.out_value = ir_buf;
- field.out_mask = NULL;
+
field.in_value = NULL;
- field.in_check_value = NULL;
- field.in_check_mask = NULL;
- field.in_handler = NULL;
- field.in_handler_priv = NULL;
+
+
+
if (tap == NULL)
jtag_add_plain_ir_scan(1, &field, my_end_state);
case XCOMMENT:
{
- int ndx = 0;
+ unsigned int ndx = 0;
char comment[128];
do
comment[sizeof(comment)-1] = 0; /* regardless, terminate */
if (verbose)
- LOG_USER(comment);
+ LOG_USER("# %s", comment);
}
break;
field.tap = tap;
field.num_bits = xsdrsize;
field.out_value = dr_out_buf;
- field.out_mask = NULL;
- field.in_value = NULL;
+ field.in_value = calloc(CEIL(field.num_bits, 8), 1);
if (attempt > 0 && verbose)
LOG_USER("LSDR retry %d", attempt);
- jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL);
if (tap == NULL)
jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
else
jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
+ jtag_check_value_mask(&field, dr_in_buf, dr_in_mask);
+
+ free(field.in_value);
+
+
/* LOG_DEBUG("FLUSHING QUEUE"); */
result = jtag_execute_queue();
if(result == ERROR_OK)