#include "xsvf.h"
#include "jtag.h"
+#include "svf.h"
/* XSVF commands, from appendix B of xapp503.pdf */
#define XSTATE_MAX_PATH 12
-static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
static int xsvf_fd = 0;
-int xsvf_register_commands(struct command_context_s *cmd_ctx)
-{
- register_command(cmd_ctx, NULL, "xsvf", handle_xsvf_command,
- COMMAND_EXEC, "run xsvf <file> [virt2] [quiet]");
-
- return ERROR_OK;
-}
-
static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf)
{
int num_bytes;
}
-static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(handle_xsvf_command)
{
uint8_t *dr_out_buf = NULL; /* from host to device (TDI) */
uint8_t *dr_in_buf = NULL; /* from device to host (TDO) */
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 */
+ bool collecting_path = false;
+ tap_state_t path[XSTATE_MAX_PATH];
+ unsigned pathlen = 0;
+
+ /* a flag telling whether to clock TCK during waits,
+ * or simply sleep, controled by virt2
+ */
+ int runtest_requires_tck = 0;
/* 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;
+ struct jtag_tap *tap = NULL;
if (argc < 2)
{
return ERROR_FAIL;
}
- filename = args[1]; /* we mess with args starting point below, snapshot filename here */
+ /* we mess with args starting point below, snapshot filename here */
+ const char *filename = args[1];
if (strcmp(args[0], "plain") != 0)
{
while (read(xsvf_fd, &opcode, 1) > 0)
{
- /* record the position of the just read opcode within the file */
+ /* record the position of this opcode within the file */
file_offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1;
+ /* maybe collect another state for a pathmove();
+ * or terminate a path.
+ */
+ if (collecting_path) {
+ tap_state_t mystate;
+ uint8_t uc;
+
+ switch (opcode) {
+ case XCOMMENT:
+ /* ignore/show comments between XSTATE ops */
+ break;
+ case XSTATE:
+ /* try to collect another transition */
+ if (pathlen == XSTATE_MAX_PATH) {
+ LOG_ERROR("XSVF: path too long");
+ do_abort = 1;
+ break;
+ }
+
+ if (read(xsvf_fd, &uc, 1) < 0)
+ {
+ do_abort = 1;
+ break;
+ }
+
+ mystate = xsvf_to_tap(uc);
+ path[pathlen++] = mystate;
+
+ LOG_DEBUG("XSTATE 0x%02X %s", uc,
+ tap_state_name(mystate));
+
+ /* If path is incomplete, collect more */
+ if (!svf_tap_state_is_stable(mystate))
+ continue;
+
+ /* Else execute the path transitions we've
+ * collected so far.
+ *
+ * NOTE: Punting on the saved path is not
+ * strictly correct, but we must to do this
+ * unless jtag_add_pathmove() stops rejecting
+ * paths containing RESET. This is probably
+ * harmless, since there aren't many options
+ * for going from a stable state to reset;
+ * at the worst, we may issue extra clocks
+ * once we get to RESET.
+ */
+ if (mystate == TAP_RESET) {
+ LOG_WARNING("XSVF: dodgey RESET");
+ path[0] = mystate;
+ }
+
+ /* FALL THROUGH */
+ default:
+ /* Execute the path we collected
+ *
+ * NOTE: OpenOCD requires something that XSVF
+ * doesn't: the last TAP state in the path
+ * must be stable. In practice, tools that
+ * create XSVF seem to follow that rule too.
+ */
+ collecting_path = false;
+
+ if (path[0] == TAP_RESET)
+ jtag_add_tlr();
+ else
+ jtag_add_pathmove(pathlen, path);
+
+ result = jtag_get_error();
+ if (result != ERROR_OK) {
+ LOG_ERROR("XSVF: pathmove error %d",
+ result);
+ do_abort = 1;
+ break;
+ }
+ continue;
+ }
+ }
+
switch (opcode)
{
case XCOMPLETE:
for (attempt = 0; attempt < limit; ++attempt)
{
- scan_field_t field;
+ struct scan_field field;
if (attempt > 0)
{
field.tap = tap;
field.num_bits = xsdrsize;
field.out_value = dr_out_buf;
- field.in_value = calloc(CEIL(field.num_bits, 8), 1);
+ field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
if (tap == NULL)
jtag_add_plain_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE));
/* See page 19 of XSVF spec regarding opcode "XSDR" */
if (xruntest)
{
- jtag_add_statemove(TAP_IDLE);
+ result = svf_add_statemove(TAP_IDLE);
if (runtest_requires_tck)
jtag_add_clocks(xruntest);
jtag_add_sleep(xruntest);
}
else if (xendir != TAP_DRPAUSE) /* we are already in TAP_DRPAUSE */
- jtag_add_statemove(xenddr);
+ result = svf_add_statemove(xenddr);
}
break;
LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate));
- /* 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.
- */
+ if (mystate == TAP_INVALID) {
+ LOG_ERROR("XSVF: bad XSTATE %02x", uc);
+ do_abort = 1;
+ break;
+ }
- if (jtag_add_statemove(mystate) != ERROR_OK)
+ /* NOTE: the current state is SVF-stable! */
+
+ /* no change == NOP */
+ if (mystate == cmd_queue_cur_state
+ && mystate != TAP_RESET)
+ break;
+
+ /* Hand off to SVF? */
+ if (svf_tap_state_is_stable(mystate))
{
- /* 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)
-);
+ result = svf_add_statemove(mystate);
+ if (result != ERROR_OK)
+ unsupported = 1;
+ break;
}
+
+ /*
+ * A sequence of XSTATE transitions, each TAP
+ * state adjacent to the previous one. Start
+ * collecting them.
+ */
+ collecting_path = true;
+ pathlen = 1;
+ path[0] = mystate;
}
break;
do_abort = 1;
else
{
- scan_field_t field;
+ struct scan_field field;
field.tap = tap;
field.num_bits = bitcount;
}
else
{
- jtag_add_statemove(wait_state);
+ /* FIXME handle statemove errors ... */
+ result = svf_add_statemove(wait_state);
jtag_add_sleep(delay);
- jtag_add_statemove(end_state);
+ result = svf_add_statemove(end_state);
}
}
break;
* 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)
+ if (!svf_tap_state_is_stable(wait_state))
{
- LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"", tap_state_name(wait_state));
+ LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"",
+ tap_state_name(wait_state));
unsupported = 1;
+ /* REVISIT "break" so we won't run? */
}
- jtag_add_statemove(wait_state);
+ /* FIXME handle statemove errors ... */
+ result = svf_add_statemove(wait_state);
jtag_add_clocks(clock_count);
jtag_add_sleep(usecs);
- jtag_add_statemove(end_state);
+ result = svf_add_statemove(end_state);
}
break;
break;
}
+ /* NOTE: loop_state must be stable! */
loop_state = xsvf_to_tap(state);
loop_clocks = be_to_h_u32(clock_buf);
loop_usecs = be_to_h_u32(usecs_buf);
for (attempt = 0; attempt < limit; ++attempt)
{
- scan_field_t field;
+ struct scan_field field;
- jtag_add_statemove(loop_state);
+ result = svf_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.in_value = calloc(CEIL(field.num_bits, 8), 1);
+ field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1);
if (attempt > 0 && verbose)
LOG_USER("LSDR retry %d", attempt);
LOG_DEBUG("xsvf failed, setting taps to reasonable state");
/* upon error, return the TAPs to a reasonable state */
- jtag_add_statemove(TAP_IDLE);
- jtag_execute_queue();
+ result = svf_add_statemove(TAP_IDLE);
+ result = jtag_execute_queue();
break;
}
}
return ERROR_OK;
}
+int xsvf_register_commands(struct command_context *cmd_ctx)
+{
+ register_command(cmd_ctx, NULL, "xsvf",
+ &handle_xsvf_command, COMMAND_EXEC,
+ "run xsvf <file> [virt2] [quiet]");
+
+ return ERROR_OK;
+}
#if 0 /* this comment style used to try and keep uncrustify from adding * at begin of line */
projects / fw / openocd / blobdiff