/**
* Function move_to_state
* moves the TAP controller from the current state to a
* \a goal_state through a path given by tap_get_tms_path(). State transition
* logging is performed by delegation to clock_tms().
*
* @param goal_state is the destination state for the move.
*/
static void move_to_state(tap_state_t goal_state)
{
tap_state_t start_state = tap_get_state();
/* goal_state is 1/2 of a tuple/pair of states which allow convenient
lookup of the required TMS pattern to move to this state from the
start state.
*/
/* do the 2 lookups */
int tms_bits = tap_get_tms_path(start_state, goal_state);
int tms_count = tap_get_tms_path_len(start_state, goal_state);
DEBUG_JTAG_IO("start=%s goal=%s", tap_state_name(start_state), tap_state_name(goal_state));
/* Track state transitions step by step */
for (int i = 0; i < tms_count; i++)
tap_set_state(tap_state_transition(tap_get_state(), (tms_bits >> i) & 1));
mpsse_clock_tms_cs_out(mpsse_ctx,
(uint8_t *)&tms_bits,
0,
tms_count,
false,
JTAG_MODE);
}
static void ftdi_execute_runtest(struct jtag_command *cmd)
{
int i;
uint8_t zero = 0;
DEBUG_JTAG_IO("runtest %i cycles, end in %s",
cmd->cmd.runtest->num_cycles,
tap_state_name(cmd->cmd.runtest->end_state));
if (tap_get_state() != TAP_IDLE)
move_to_state(TAP_IDLE);
/* TODO: Reuse ftdi_execute_stableclocks */
i = cmd->cmd.runtest->num_cycles;
while (i > 0) {
/* there are no state transitions in this code, so omit state tracking */
unsigned this_len = i > 7 ? 7 : i;
mpsse_clock_tms_cs_out(mpsse_ctx, &zero, 0, this_len, false, JTAG_MODE);
i -= this_len;
}
ftdi_end_state(cmd->cmd.runtest->end_state);
if (tap_get_state() != tap_get_end_state())
move_to_state(tap_get_end_state());
DEBUG_JTAG_IO("runtest: %i, end in %s",
cmd->cmd.runtest->num_cycles,
tap_state_name(tap_get_end_state()));
}
void jtag_add_pathmove(int num_states, const tap_state_t *path)
{
tap_state_t cur_state = cmd_queue_cur_state;
/* the last state has to be a stable state */
if (!tap_is_state_stable(path[num_states - 1])) {
LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
return;
}
for (int i = 0; i < num_states; i++) {
if (path[i] == TAP_RESET) {
LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
jtag_set_error(ERROR_JTAG_STATE_INVALID);
return;
}
if (tap_state_transition(cur_state, true) != path[i] &&
tap_state_transition(cur_state, false) != path[i]) {
LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
tap_state_name(cur_state), tap_state_name(path[i]));
jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
return;
}
cur_state = path[i];
}
jtag_checks();
jtag_set_error(interface_jtag_add_pathmove(num_states, path));
cmd_queue_cur_state = path[num_states - 1];
}
int jtag_add_statemove(tap_state_t goal_state)
{
tap_state_t cur_state = cmd_queue_cur_state;
if (goal_state != cur_state) {
LOG_DEBUG("cur_state=%s goal_state=%s",
tap_state_name(cur_state),
tap_state_name(goal_state));
}
/* If goal is RESET, be paranoid and force that that transition
* (e.g. five TCK cycles, TMS high). Else trust "cur_state".
*/
if (goal_state == TAP_RESET)
jtag_add_tlr();
else if (goal_state == cur_state)
/* nothing to do */;
else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state)) {
unsigned tms_bits = tap_get_tms_path(cur_state, goal_state);
unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
tap_state_t moves[8];
assert(tms_count < ARRAY_SIZE(moves));
for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1) {
bool bit = tms_bits & 1;
cur_state = tap_state_transition(cur_state, bit);
moves[i] = cur_state;
}
jtag_add_pathmove(tms_count, moves);
} else if (tap_state_transition(cur_state, true) == goal_state
static int osbdm_add_pathmove(
struct queue *queue,
tap_state_t *path,
int num_states)
{
assert(num_states <= 32);
struct sequence *next = queue_add_tail(queue, num_states);
if (!next) {
LOG_ERROR("BUG: can't allocate bit sequence");
return ERROR_FAIL;
}
uint32_t tms = 0;
for (int i = 0; i < num_states; i++) {
if (tap_state_transition(tap_get_state(), 1) == path[i]) {
tms |= (1 << i);
} else if (tap_state_transition(tap_get_state(), 0) == path[i]) {
tms &= ~(1 << i); /* This line not so needed */
} else {
LOG_ERROR("BUG: %s -> %s isn't a valid TAP state transition",
tap_state_name(tap_get_state()),
tap_state_name(path[i]));
return ERROR_FAIL;
}
tap_set_state(path[i]);
}
buf_set_u32(next->tms, 0, num_states, tms);
tap_set_end_state(tap_get_state());
return ERROR_OK;
}
int interface_jtag_add_pathmove(int num_states, const tap_state_t *path)
{
int state_count;
int tms = 0;
state_count = 0;
tap_state_t cur_state = cmd_queue_cur_state;
while (num_states) {
if (tap_state_transition(cur_state, false) == path[state_count])
tms = 0;
else if (tap_state_transition(cur_state, true) == path[state_count])
tms = 1;
else {
LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
tap_state_name(cur_state), tap_state_name(path[state_count]));
exit(-1);
}
/* synchronously do the operation here */
cur_state = path[state_count];
state_count++;
num_states--;
}
/* synchronously do the operation here */
return ERROR_OK;
}
static void shiftValueInnerFlip(const tap_state_t state, const tap_state_t endState, int repeat, cyg_uint32 value)
{
VERBOSE(LOG_INFO("shiftValueInner %s %s %d %08x (flipped)", tap_state_name(state), tap_state_name(endState), repeat, value));
cyg_uint32 a,b;
a=state;
b=endState;
ZY1000_POKE(ZY1000_JTAG_BASE+0xc, value);
ZY1000_POKE(ZY1000_JTAG_BASE+0x8, (1<<15)|(repeat<<8)|(a<<4)|b);
VERBOSE(getShiftValueFlip());
}
static int ftdi_execute_pathmove(struct jtag_command *cmd)
{
int retval = ERROR_OK;
tap_state_t *path = cmd->cmd.pathmove->path;
int num_states = cmd->cmd.pathmove->num_states;
DEBUG_JTAG_IO("pathmove: %i states, current: %s end: %s", num_states,
tap_state_name(tap_get_state()),
tap_state_name(path[num_states-1]));
int state_count = 0;
unsigned bit_count = 0;
uint8_t tms_byte = 0;
DEBUG_JTAG_IO("-");
/* this loop verifies that the path is legal and logs each state in the path */
while (num_states-- && retval == ERROR_OK) {
/* either TMS=0 or TMS=1 must work ... */
if (tap_state_transition(tap_get_state(), false)
== path[state_count])
buf_set_u32(&tms_byte, bit_count++, 1, 0x0);
else if (tap_state_transition(tap_get_state(), true)
== path[state_count]) {
buf_set_u32(&tms_byte, bit_count++, 1, 0x1);
/* ... or else the caller goofed BADLY */
} else {
LOG_ERROR("BUG: %s -> %s isn't a valid "
"TAP state transition",
tap_state_name(tap_get_state()),
tap_state_name(path[state_count]));
exit(-1);
}
tap_set_state(path[state_count]);
state_count++;
if (bit_count == 7 || num_states == 0) {
retval = mpsse_clock_tms_cs_out(mpsse_ctx,
&tms_byte,
0,
bit_count,
false,
JTAG_MODE);
bit_count = 0;
}
}
tap_set_end_state(tap_get_state());
return retval;
}
static void jtag_vpi_state_move(tap_state_t state)
{
uint8_t tms_scan;
int tms_len;
LOG_DEBUG("jtag_vpi_state_move: (from %s to %s)", tap_state_name(tap_get_state()),
tap_state_name(state));
if (tap_get_state() == state)
return;
tms_scan = tap_get_tms_path(tap_get_state(), state);
tms_len = tap_get_tms_path_len(tap_get_state(), state);
jtag_vpi_tms_seq(&tms_scan, tms_len);
tap_set_state(state);
}
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 ftdi_execute_stableclocks(struct jtag_command *cmd)
{
int retval = ERROR_OK;
/* this is only allowed while in a stable state. A check for a stable
* state was done in jtag_add_clocks()
*/
int num_cycles = cmd->cmd.stableclocks->num_cycles;
/* 7 bits of either ones or zeros. */
uint8_t tms = tap_get_state() == TAP_RESET ? 0x7f : 0x00;
/* TODO: Use mpsse_clock_data with in=out=0 for this, if TMS can be set to
* the correct level and remain there during the scan */
while (num_cycles > 0 && retval == ERROR_OK) {
/* there are no state transitions in this code, so omit state tracking */
unsigned this_len = num_cycles > 7 ? 7 : num_cycles;
retval = mpsse_clock_tms_cs_out(mpsse_ctx, &tms, 0, this_len, false, JTAG_MODE);
num_cycles -= this_len;
}
DEBUG_JTAG_IO("clocks %i while in %s",
cmd->cmd.stableclocks->num_cycles,
tap_state_name(tap_get_state()));
return retval;
}
static void ftdi_end_state(tap_state_t state)
{
if (tap_is_state_stable(state))
tap_set_end_state(state);
else {
LOG_ERROR("BUG: %s is not a stable end state", tap_state_name(state));
exit(-1);
}
}
static void ftdi_execute_sleep(struct jtag_command *cmd)
{
DEBUG_JTAG_IO("sleep %" PRIi32, cmd->cmd.sleep->us);
mpsse_flush(mpsse_ctx);
jtag_sleep(cmd->cmd.sleep->us);
DEBUG_JTAG_IO("sleep %" PRIi32 " usec while in %s",
cmd->cmd.sleep->us,
tap_state_name(tap_get_state()));
}
static void vsllink_path_move(int num_states, tap_state_t *path)
{
for (int i = 0; i < num_states; i++) {
if (path[i] == tap_state_transition(tap_get_state(), false))
vsllink_tap_append_step(0, 0);
else if (path[i] == tap_state_transition(tap_get_state(), true))
vsllink_tap_append_step(1, 0);
else {
LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
tap_state_name(tap_get_state()),
tap_state_name(path[i]));
exit(-1);
}
tap_set_state(path[i]);
}
tap_set_end_state(tap_get_state());
}
static void ftdi_execute_statemove(struct jtag_command *cmd)
{
DEBUG_JTAG_IO("statemove end in %s",
tap_state_name(cmd->cmd.statemove->end_state));
ftdi_end_state(cmd->cmd.statemove->end_state);
/* shortest-path move to desired end state */
if (tap_get_state() != tap_get_end_state() || tap_get_end_state() == TAP_RESET)
move_to_state(tap_get_end_state());
}
static void jlink_path_move(int num_states, tap_state_t *path)
{
int i;
uint8_t tms = 0xff;
for (i = 0; i < num_states; i++) {
if (path[i] == tap_state_transition(tap_get_state(), false))
jlink_clock_data(NULL, 0, NULL, 0, NULL, 0, 1);
else if (path[i] == tap_state_transition(tap_get_state(), true))
jlink_clock_data(NULL, 0, &tms, 0, NULL, 0, 1);
else {
LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition.",
tap_state_name(tap_get_state()), tap_state_name(path[i]));
exit(-1);
}
tap_set_state(path[i]);
}
tap_set_end_state(tap_get_state());
}
static int ftdi_execute_sleep(struct jtag_command *cmd)
{
int retval = ERROR_OK;
DEBUG_JTAG_IO("sleep %" PRIi32, cmd->cmd.sleep->us);
retval = mpsse_flush(mpsse_ctx);
jtag_sleep(cmd->cmd.sleep->us);
DEBUG_JTAG_IO("sleep %" PRIi32 " usec while in %s",
cmd->cmd.sleep->us,
tap_state_name(tap_get_state()));
return retval;
}
static void jlink_execute_scan(struct jtag_command *cmd)
{
DEBUG_JTAG_IO("%s type:%d", cmd->cmd.scan->ir_scan ? "IRSCAN" : "DRSCAN",
jtag_scan_type(cmd->cmd.scan));
/* Make sure there are no trailing fields with num_bits == 0, or the logic below will fail. */
while (cmd->cmd.scan->num_fields > 0
&& cmd->cmd.scan->fields[cmd->cmd.scan->num_fields - 1].num_bits == 0) {
cmd->cmd.scan->num_fields--;
LOG_DEBUG("discarding trailing empty field");
}
if (cmd->cmd.scan->num_fields == 0) {
LOG_DEBUG("empty scan, doing nothing");
return;
}
if (cmd->cmd.scan->ir_scan) {
if (tap_get_state() != TAP_IRSHIFT) {
jlink_end_state(TAP_IRSHIFT);
jlink_state_move();
}
} else {
if (tap_get_state() != TAP_DRSHIFT) {
jlink_end_state(TAP_DRSHIFT);
jlink_state_move();
}
}
jlink_end_state(cmd->cmd.scan->end_state);
struct scan_field *field = cmd->cmd.scan->fields;
unsigned scan_size = 0;
for (int i = 0; i < cmd->cmd.scan->num_fields; i++, field++) {
scan_size += field->num_bits;
DEBUG_JTAG_IO("%s%s field %d/%d %d bits",
field->in_value ? "in" : "",
field->out_value ? "out" : "",
i,
cmd->cmd.scan->num_fields,
field->num_bits);
if (i == cmd->cmd.scan->num_fields - 1 && tap_get_state() != tap_get_end_state()) {
/* Last field, and we're leaving IRSHIFT/DRSHIFT. Clock last bit during tap
* movement. This last field can't have length zero, it was checked above. */
jlink_clock_data(field->out_value,
0,
NULL,
0,
field->in_value,
0,
field->num_bits - 1);
uint8_t last_bit = 0;
if (field->out_value)
bit_copy(&last_bit, 0, field->out_value, field->num_bits - 1, 1);
uint8_t tms_bits = 0x01;
jlink_clock_data(&last_bit,
0,
&tms_bits,
0,
field->in_value,
field->num_bits - 1,
1);
tap_set_state(tap_state_transition(tap_get_state(), 1));
jlink_clock_data(&last_bit,
0,
&tms_bits,
1,
NULL,
0,
1);
tap_set_state(tap_state_transition(tap_get_state(), 0));
} else
jlink_clock_data(field->out_value,
0,
NULL,
0,
field->in_value,
0,
field->num_bits);
}
if (tap_get_state() != tap_get_end_state()) {
jlink_end_state(tap_get_end_state());
jlink_state_move();
}
DEBUG_JTAG_IO("%s scan, %i bits, end in %s",
(cmd->cmd.scan->ir_scan) ? "IR" : "DR", scan_size,
tap_state_name(tap_get_end_state()));
}
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) */
u8 *dr_in_buf = NULL; /* from device to host (TDO) */
u8 *dr_in_mask = NULL;
int xsdrsize = 0;
int xruntest = 0; /* number of TCK cycles OR microseconds */
int xrepeat = 0; /* number of retries */
tap_state_t xendir = TAP_IDLE; /* see page 8 of the SVF spec, initial xendir to be TAP_IDLE */
tap_state_t xenddr = TAP_IDLE;
u8 opcode;
u8 uc;
long file_offset = 0;
int loop_count = 0;
tap_state_t loop_state = TAP_IDLE;
int loop_clocks = 0;
int loop_usecs = 0;
int do_abort = 0;
int unsupported = 0;
int tdo_mismatch = 0;
int result;
int verbose = 1;
char* filename;
int runtest_requires_tck = 0; /* a flag telling whether to clock TCK during waits, or simply sleep, controled by virt2 */
/* use NULL to indicate a "plain" xsvf file which accounts for
additional devices in the scan chain, otherwise the device
that should be affected
*/
jtag_tap_t *tap = NULL;
if (argc < 2)
{
command_print(cmd_ctx, "usage: xsvf <device#|plain> <file> [<variant>] [quiet]");
return ERROR_FAIL;
}
filename = args[1]; /* we mess with args starting point below, snapshot filename here */
if (strcmp(args[0], "plain") != 0)
{
tap = jtag_TapByString( args[0] );
if (!tap )
{
command_print( cmd_ctx, "Tap: %s unknown", args[0] );
return ERROR_FAIL;
}
}
if ((xsvf_fd = open(filename, O_RDONLY)) < 0)
{
command_print(cmd_ctx, "file \"%s\" not found", filename);
return ERROR_FAIL;
}
/* if this argument is present, then interpret xruntest counts as TCK cycles rather than as usecs */
if ((argc > 2) && (strcmp(args[2], "virt2") == 0))
{
runtest_requires_tck = 1;
--argc;
++args;
}
if ((argc > 2) && (strcmp(args[2], "quiet") == 0))
{
verbose = 0;
}
LOG_USER("xsvf processing file: \"%s\"", filename);
while( read(xsvf_fd, &opcode, 1) > 0 )
{
/* record the position of the just read opcode within the file */
file_offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1;
switch (opcode)
{
case XCOMPLETE:
LOG_DEBUG("XCOMPLETE");
result = jtag_execute_queue();
if (result != ERROR_OK)
{
tdo_mismatch = 1;
break;
}
break;
case XTDOMASK:
LOG_DEBUG("XTDOMASK");
if (dr_in_mask && (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_mask) != ERROR_OK))
do_abort = 1;
break;
case XRUNTEST:
{
u8 xruntest_buf[4];
if (read(xsvf_fd, xruntest_buf, 4) < 0)
{
do_abort = 1;
break;
}
xruntest = be_to_h_u32(xruntest_buf);
LOG_DEBUG("XRUNTEST %d 0x%08X", xruntest, xruntest);
}
break;
case XREPEAT:
{
u8 myrepeat;
if (read(xsvf_fd, &myrepeat, 1) < 0)
do_abort = 1;
else
{
xrepeat = myrepeat;
LOG_DEBUG("XREPEAT %d", xrepeat );
}
}
break;
case XSDRSIZE:
{
u8 xsdrsize_buf[4];
if (read(xsvf_fd, xsdrsize_buf, 4) < 0)
{
do_abort = 1;
break;
}
xsdrsize = be_to_h_u32(xsdrsize_buf);
LOG_DEBUG("XSDRSIZE %d", xsdrsize);
if( dr_out_buf ) free(dr_out_buf);
if( dr_in_buf) free(dr_in_buf);
if( dr_in_mask) free(dr_in_mask);
dr_out_buf = malloc((xsdrsize + 7) / 8);
dr_in_buf = malloc((xsdrsize + 7) / 8);
dr_in_mask = malloc((xsdrsize + 7) / 8);
}
break;
case XSDR: /* these two are identical except for the dr_in_buf */
case XSDRTDO:
{
int limit = xrepeat;
int matched = 0;
int attempt;
const char* op_name = (opcode == XSDR ? "XSDR" : "XSDRTDO");
if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK)
{
do_abort = 1;
break;
}
if (opcode == XSDRTDO)
{
if(xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK )
{
do_abort = 1;
break;
}
}
if (limit < 1)
limit = 1;
LOG_DEBUG("%s %d", op_name, xsdrsize);
for( attempt=0; attempt<limit; ++attempt )
{
scan_field_t field;
if( attempt>0 )
{
/* perform the XC9500 exception handling sequence shown in xapp067.pdf and
illustrated in psuedo code at end of this file. We start from state
DRPAUSE:
go to Exit2-DR
go to Shift-DR
go to Exit1-DR
go to Update-DR
go to Run-Test/Idle
This sequence should be harmless for other devices, and it
will be skipped entirely if xrepeat is set to zero.
*/
static tap_state_t exception_path[] = {
TAP_DREXIT2,
TAP_DRSHIFT,
TAP_DREXIT1,
TAP_DRUPDATE,
TAP_IDLE,
};
jtag_add_pathmove( sizeof(exception_path)/sizeof(exception_path[0]), exception_path);
if (verbose)
LOG_USER("%s %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);
if (tap == NULL)
jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE);
else
jtag_add_dr_scan(1, &field, TAP_DRPAUSE);
/* LOG_DEBUG("FLUSHING QUEUE"); */
result = jtag_execute_queue();
if (result == ERROR_OK)
{
matched = 1;
break;
}
}
if (!matched)
{
LOG_USER( "%s mismatch", op_name);
tdo_mismatch = 1;
break;
}
/* See page 19 of XSVF spec regarding opcode "XSDR" */
if (xruntest)
{
xsvf_add_statemove(TAP_IDLE);
if (runtest_requires_tck)
jtag_add_clocks(xruntest);
else
jtag_add_sleep(xruntest);
}
else if (xendir != TAP_DRPAUSE) /* we are already in TAP_DRPAUSE */
xsvf_add_statemove(xenddr);
}
break;
case XSETSDRMASKS:
LOG_ERROR("unsupported XSETSDRMASKS\n");
unsupported = 1;
break;
case XSDRINC:
LOG_ERROR("unsupported XSDRINC\n");
unsupported = 1;
break;
case XSDRB:
LOG_ERROR("unsupported XSDRB\n");
unsupported = 1;
break;
case XSDRC:
LOG_ERROR("unsupported XSDRC\n");
unsupported = 1;
break;
case XSDRE:
LOG_ERROR("unsupported XSDRE\n");
unsupported = 1;
break;
case XSDRTDOB:
LOG_ERROR("unsupported XSDRTDOB\n");
unsupported = 1;
break;
case XSDRTDOC:
LOG_ERROR("unsupported XSDRTDOC\n");
unsupported = 1;
break;
case XSDRTDOE:
LOG_ERROR("unsupported XSDRTDOE\n");
unsupported = 1;
break;
case XSTATE:
{
tap_state_t mystate;
tap_state_t *path;
int path_len;
if (read(xsvf_fd, &uc, 1) < 0)
{
do_abort = 1;
break;
}
mystate = xsvf_to_tap(uc);
LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate) );
path = calloc(XSTATE_MAX_PATH, 4);
path_len = 1;
path[0] = mystate;
if (xsvf_read_xstates(xsvf_fd, path, XSTATE_MAX_PATH, &path_len) != ERROR_OK)
do_abort = 1;
else
{
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);
}
}
free(path);
}
break;
case XENDIR:
{
tap_state_t mystate;
if (read(xsvf_fd, &uc, 1) < 0)
{
do_abort = 1;
break;
}
/* see page 22 of XSVF spec */
mystate = uc == 1 ? TAP_IRPAUSE : TAP_IDLE;
LOG_DEBUG("XENDIR 0x%02X %s", uc, tap_state_name(mystate));
/* assuming that the XRUNTEST comes from SVF RUNTEST, then only these states
* should come here because the SVF spec only allows these with a RUNTEST
*/
if (mystate != TAP_IRPAUSE && mystate != TAP_DRPAUSE && mystate != TAP_RESET && mystate != TAP_IDLE )
{
LOG_ERROR("illegal XENDIR endstate: \"%s\"", tap_state_name(mystate));
unsupported = 1;
break;
}
xendir = mystate;
}
break;
case XENDDR:
{
tap_state_t mystate;
if (read(xsvf_fd, &uc, 1) < 0)
{
do_abort = 1;
break;
}
/* see page 22 of XSVF spec */
mystate = uc == 1 ? TAP_DRPAUSE : TAP_IDLE;
LOG_DEBUG("XENDDR %02X %s", uc, tap_state_name(mystate));
if (mystate != TAP_IRPAUSE && mystate != TAP_DRPAUSE && mystate != TAP_RESET && mystate != TAP_IDLE )
{
LOG_ERROR("illegal XENDDR endstate: \"%s\"", tap_state_name( mystate ));
unsupported = 1;
break;
}
xenddr = mystate;
}
break;
case XSIR:
case XSIR2:
{
u8 short_buf[2];
u8* ir_buf;
int bitcount;
tap_state_t my_end_state = xruntest ? TAP_IDLE : xendir;
if( opcode == XSIR )
{
/* one byte bitcount */
if (read(xsvf_fd, short_buf, 1) < 0)
{
do_abort = 1;
break;
}
bitcount = short_buf[0];
LOG_DEBUG("XSIR %d", bitcount);
}
else
{
if (read(xsvf_fd, short_buf, 2) < 0)
{
do_abort = 1;
break;
}
bitcount = be_to_h_u16(short_buf);
LOG_DEBUG("XSIR2 %d", bitcount);
}
ir_buf = malloc((bitcount+7) / 8);
if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK)
do_abort = 1;
else
{
scan_field_t field;
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);
else
jtag_add_ir_scan(1, &field, my_end_state);
if (xruntest)
{
if (runtest_requires_tck)
jtag_add_clocks(xruntest);
else
jtag_add_sleep(xruntest);
}
/* Note that an -irmask of non-zero in your config file
* can cause this to fail. Setting -irmask to zero cand work
* around the problem.
*/
/* LOG_DEBUG("FLUSHING QUEUE"); */
result = jtag_execute_queue();
if(result != ERROR_OK)
{
tdo_mismatch = 1;
}
}
free(ir_buf);
}
break;
case XCOMMENT:
{
int ndx = 0;
char comment[128];
do
{
if (read(xsvf_fd, &uc, 1) < 0)
{
do_abort = 1;
break;
}
if ( ndx < sizeof(comment)-1 )
comment[ndx++] = uc;
} while (uc != 0);
comment[sizeof(comment)-1] = 0; /* regardless, terminate */
if (verbose)
LOG_USER(comment);
}
break;
case XWAIT:
{
/* expected in stream:
XWAIT <u8 wait_state> <u8 end_state> <u32 usecs>
*/
u8 wait;
u8 end;
u8 delay_buf[4];
tap_state_t wait_state;
tap_state_t end_state;
int delay;
if ( read(xsvf_fd, &wait, 1) < 0
|| read(xsvf_fd, &end, 1) < 0
|| read(xsvf_fd, delay_buf, 4) < 0)
{
do_abort = 1;
break;
}
wait_state = xsvf_to_tap(wait);
end_state = xsvf_to_tap(end);
delay = be_to_h_u32(delay_buf);
LOG_DEBUG("XWAIT %s %s usecs:%d", tap_state_name(wait_state), tap_state_name(end_state), delay);
if (runtest_requires_tck && wait_state == TAP_IDLE )
{
jtag_add_runtest(delay, end_state);
}
else
{
xsvf_add_statemove( wait_state );
jtag_add_sleep(delay);
xsvf_add_statemove( end_state );
}
}
break;
case XWAITSTATE:
{
/* expected in stream:
XWAITSTATE <u8 wait_state> <u8 end_state> <u32 clock_count> <u32 usecs>
*/
u8 clock_buf[4];
u8 usecs_buf[4];
u8 wait;
u8 end;
tap_state_t wait_state;
tap_state_t end_state;
int clock_count;
int usecs;
if ( read(xsvf_fd, &wait, 1) < 0
|| read(xsvf_fd, &end, 1) < 0
|| read(xsvf_fd, clock_buf, 4) < 0
|| read(xsvf_fd, usecs_buf, 4) < 0 )
{
do_abort = 1;
break;
}
wait_state = xsvf_to_tap( wait );
end_state = xsvf_to_tap( end );
clock_count = be_to_h_u32(clock_buf);
usecs = be_to_h_u32(usecs_buf);
LOG_DEBUG("XWAITSTATE %s %s clocks:%i usecs:%i",
tap_state_name(wait_state),
tap_state_name(end_state),
clock_count, usecs);
/* the following states are 'stable', meaning that they have a transition
* in the state diagram back to themselves. This is necessary because we will
* be issuing a number of clocks in this state. This set of allowed states is also
* determined by the SVF RUNTEST command's allowed states.
*/
if (wait_state != TAP_IRPAUSE && wait_state != TAP_DRPAUSE && wait_state != TAP_RESET && wait_state != TAP_IDLE)
{
LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"", tap_state_name( wait_state ));
unsupported = 1;
}
xsvf_add_statemove( wait_state );
jtag_add_clocks( clock_count );
jtag_add_sleep( usecs );
xsvf_add_statemove( end_state );
}
break;
case LCOUNT:
{
/* expected in stream:
LCOUNT <u32 loop_count>
*/
u8 count_buf[4];
if ( read(xsvf_fd, count_buf, 4) < 0 )
{
do_abort = 1;
break;
}
loop_count = be_to_h_u32(count_buf);
LOG_DEBUG("LCOUNT %d", loop_count);
}
break;
case LDELAY:
{
/* expected in stream:
LDELAY <u8 wait_state> <u32 clock_count> <u32 usecs_to_sleep>
*/
u8 state;
u8 clock_buf[4];
u8 usecs_buf[4];
if ( read(xsvf_fd, &state, 1) < 0
|| read(xsvf_fd, clock_buf, 4) < 0
|| read(xsvf_fd, usecs_buf, 4) < 0 )
{
do_abort = 1;
break;
}
loop_state = xsvf_to_tap(state);
loop_clocks = be_to_h_u32(clock_buf);
loop_usecs = be_to_h_u32(usecs_buf);
LOG_DEBUG("LDELAY %s clocks:%d usecs:%d", tap_state_name(loop_state), loop_clocks, loop_usecs);
}
break;
/* LSDR is more like XSDRTDO than it is like XSDR. It uses LDELAY which
* comes with clocks !AND! sleep requirements.
*/
case LSDR:
{
int limit = loop_count;
int matched = 0;
int attempt;
LOG_DEBUG("LSDR");
if ( xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK
|| xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK )
{
do_abort = 1;
break;
}
if (limit < 1)
limit = 1;
for( attempt=0; attempt<limit; ++attempt )
{
scan_field_t field;
xsvf_add_statemove( loop_state );
jtag_add_clocks(loop_clocks);
jtag_add_sleep(loop_usecs);
field.tap = tap;
field.num_bits = xsdrsize;
field.out_value = dr_out_buf;
field.out_mask = NULL;
field.in_value = NULL;
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);
/* LOG_DEBUG("FLUSHING QUEUE"); */
result = jtag_execute_queue();
if(result == ERROR_OK)
{
matched = 1;
break;
}
}
if (!matched )
{
LOG_USER( "LSDR mismatch" );
tdo_mismatch = 1;
break;
}
}
break;
case XTRST:
{
u8 trst_mode;
if (read(xsvf_fd, &trst_mode, 1) < 0)
{
do_abort = 1;
break;
}
switch( trst_mode )
{
case XTRST_ON:
jtag_add_reset(1, 0);
break;
case XTRST_OFF:
case XTRST_Z:
jtag_add_reset(0, 0);
break;
case XTRST_ABSENT:
break;
default:
LOG_ERROR( "XTRST mode argument (0x%02X) out of range", trst_mode );
do_abort = 1;
}
}
break;
default:
LOG_ERROR("unknown xsvf command (0x%02X)\n", uc);
unsupported = 1;
}
if (do_abort || unsupported || tdo_mismatch)
{
LOG_DEBUG("xsvf failed, setting taps to reasonable state");
/* upon error, return the TAPs to a reasonable state */
xsvf_add_statemove( TAP_IDLE );
jtag_execute_queue();
break;
}
}
if (tdo_mismatch)
{
command_print(cmd_ctx, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting",
file_offset );
return ERROR_FAIL;
}
if (unsupported)
{
command_print(cmd_ctx,
"unsupported xsvf command: 0x%02X in xsvf file at offset %ld, aborting",
uc, lseek(xsvf_fd, 0, SEEK_CUR)-1 );
return ERROR_FAIL;
}
if (do_abort)
{
command_print(cmd_ctx, "premature end of xsvf file detected, aborting");
return ERROR_FAIL;
}
if (dr_out_buf)
free(dr_out_buf);
if (dr_in_buf)
free(dr_in_buf);
if (dr_in_mask)
free(dr_in_mask);
close(xsvf_fd);
command_print(cmd_ctx, "XSVF file programmed successfully");
return ERROR_OK;
}
static int ftdi_execute_scan(struct jtag_command *cmd)
{
int retval = ERROR_OK;
DEBUG_JTAG_IO("%s type:%d", cmd->cmd.scan->ir_scan ? "IRSCAN" : "DRSCAN",
jtag_scan_type(cmd->cmd.scan));
if (cmd->cmd.scan->ir_scan) {
if (tap_get_state() != TAP_IRSHIFT)
move_to_state(TAP_IRSHIFT);
} else {
if (tap_get_state() != TAP_DRSHIFT)
move_to_state(TAP_DRSHIFT);
}
ftdi_end_state(cmd->cmd.scan->end_state);
struct scan_field *field = cmd->cmd.scan->fields;
unsigned scan_size = 0;
for (int i = 0; i < cmd->cmd.scan->num_fields; i++, field++) {
scan_size += field->num_bits;
DEBUG_JTAG_IO("%s%s field %d/%d %d bits",
field->in_value ? "in" : "",
field->out_value ? "out" : "",
i,
cmd->cmd.scan->num_fields,
field->num_bits);
if (i == cmd->cmd.scan->num_fields - 1 && tap_get_state() != tap_get_end_state()) {
/* Last field, and we're leaving IRSHIFT/DRSHIFT. Clock last bit during tap
*movement */
mpsse_clock_data(mpsse_ctx,
field->out_value,
0,
field->in_value,
0,
field->num_bits - 1,
JTAG_MODE);
uint8_t last_bit = 0;
if (field->out_value)
bit_copy(&last_bit, 0, field->out_value, field->num_bits - 1, 1);
uint8_t tms_bits = 0x01;
retval = mpsse_clock_tms_cs(mpsse_ctx,
&tms_bits,
0,
field->in_value,
field->num_bits - 1,
1,
last_bit,
JTAG_MODE);
tap_set_state(tap_state_transition(tap_get_state(), 1));
retval = mpsse_clock_tms_cs_out(mpsse_ctx,
&tms_bits,
1,
1,
last_bit,
JTAG_MODE);
tap_set_state(tap_state_transition(tap_get_state(), 0));
} else
mpsse_clock_data(mpsse_ctx,
field->out_value,
0,
field->in_value,
0,
field->num_bits,
JTAG_MODE);
if (retval != ERROR_OK) {
LOG_ERROR("failed to add field %d in scan", i);
return retval;
}
}
if (tap_get_state() != tap_get_end_state())
move_to_state(tap_get_end_state());
DEBUG_JTAG_IO("%s scan, %i bits, end in %s",
(cmd->cmd.scan->ir_scan) ? "IR" : "DR", scan_size,
tap_state_name(tap_get_end_state()));
return retval;
}
static int vsllink_execute_queue(void)
{
struct jtag_command *cmd = jtag_command_queue;
int scan_size;
enum scan_type type;
uint8_t *buffer;
DEBUG_JTAG_IO("-------------------------------------"
" vsllink "
"-------------------------------------");
while (cmd != NULL) {
switch (cmd->type) {
case JTAG_RUNTEST:
DEBUG_JTAG_IO("runtest %i cycles, end in %s",
cmd->cmd.runtest->num_cycles,
tap_state_name(cmd->cmd.runtest->end_state));
vsllink_end_state(cmd->cmd.runtest->end_state);
vsllink_runtest(cmd->cmd.runtest->num_cycles);
break;
case JTAG_TLR_RESET:
DEBUG_JTAG_IO("statemove end in %s",
tap_state_name(cmd->cmd.statemove->end_state));
vsllink_end_state(cmd->cmd.statemove->end_state);
vsllink_state_move();
break;
case JTAG_PATHMOVE:
DEBUG_JTAG_IO("pathmove: %i states, end in %s",
cmd->cmd.pathmove->num_states,
tap_state_name(cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]));
vsllink_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
break;
case JTAG_SCAN:
DEBUG_JTAG_IO("JTAG Scan...");
vsllink_end_state(cmd->cmd.scan->end_state);
scan_size = jtag_build_buffer(
cmd->cmd.scan, &buffer);
if (cmd->cmd.scan->ir_scan)
DEBUG_JTAG_IO(
"JTAG Scan write IR(%d bits), "
"end in %s:",
scan_size,
tap_state_name(cmd->cmd.scan->end_state));
else
DEBUG_JTAG_IO(
"JTAG Scan write DR(%d bits), "
"end in %s:",
scan_size,
tap_state_name(cmd->cmd.scan->end_state));
#ifdef _DEBUG_JTAG_IO_
vsllink_debug_buffer(buffer,
DIV_ROUND_UP(scan_size, 8));
#endif
type = jtag_scan_type(cmd->cmd.scan);
vsllink_scan(cmd->cmd.scan->ir_scan,
type, buffer, scan_size,
cmd->cmd.scan);
break;
case JTAG_RESET:
DEBUG_JTAG_IO("reset trst: %i srst %i",
cmd->cmd.reset->trst,
cmd->cmd.reset->srst);
vsllink_tap_execute();
if (cmd->cmd.reset->trst == 1)
tap_set_state(TAP_RESET);
vsllink_reset(cmd->cmd.reset->trst,
cmd->cmd.reset->srst);
break;
case JTAG_SLEEP:
DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us);
vsllink_tap_execute();
jtag_sleep(cmd->cmd.sleep->us);
break;
case JTAG_STABLECLOCKS:
DEBUG_JTAG_IO("add %d clocks",
cmd->cmd.stableclocks->num_cycles);
switch (tap_get_state()) {
case TAP_RESET:
/* tms must be '1' to stay
* n TAP_RESET mode
*/
scan_size = 1;
break;
case TAP_DRSHIFT:
case TAP_IDLE:
case TAP_DRPAUSE:
case TAP_IRSHIFT:
case TAP_IRPAUSE:
/* else, tms should be '0' */
scan_size = 0;
break;
/* above stable states are OK */
default:
LOG_ERROR("jtag_add_clocks() "
"in non-stable state \"%s\"",
tap_state_name(tap_get_state())
);
exit(-1);
}
vsllink_stableclocks(cmd->cmd.stableclocks->num_cycles, scan_size);
break;
case JTAG_TMS:
DEBUG_JTAG_IO("add %d jtag tms",
cmd->cmd.tms->num_bits);
vsllink_tms(cmd->cmd.tms->num_bits, cmd->cmd.tms->bits);
break;
default:
LOG_ERROR("BUG: unknown JTAG command type "
"encountered: %d", cmd->type);
exit(-1);
}
cmd = cmd->next;
}
return vsllink_tap_execute();
}
