X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=src%2Fxsvf%2Fxsvf.c;h=51d0e7b1eaa79f1035b5a6a100208df9d6c322f2;hb=cd9c61cc068635fa707981decfea600ee7e94201;hp=1bcc5d026b20b898df7717ba89bc25fea2d287f4;hpb=9324e6280edfda501d1cf52e5d46b1c4aa083935;p=fw%2Fopenocd diff --git a/src/xsvf/xsvf.c b/src/xsvf/xsvf.c index 1bcc5d026..51d0e7b1e 100644 --- a/src/xsvf/xsvf.c +++ b/src/xsvf/xsvf.c @@ -1,31 +1,30 @@ -/*************************************************************************** - * Copyright (C) 2005 by Dominic Rath * - * Dominic.Rath@gmx.de * - * * - * Copyright (C) 2007,2008 Øyvind Harboe * - * oyvind.harboe@zylin.com * - * * - * Copyright (C) 2008 Peter Hettkamp * - * peter.hettkamp@htp-tel.de * - * * - * Copyright (C) 2009 SoftPLC Corporation. http://softplc.com * - * dick@softplc.com * - * * - * 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. * - ***************************************************************************/ +/* + * Copyright (C) 2005 by Dominic Rath + * Dominic.Rath@gmx.de + * + * Copyright (C) 2007,2008 Øyvind Harboe + * oyvind.harboe@zylin.com + * + * Copyright (C) 2008 Peter Hettkamp + * peter.hettkamp@htp-tel.de + * + * Copyright (C) 2009 SoftPLC Corporation. http://softplc.com + * Dick Hollenbeck + * + * 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 + */ /* The specification for SVF is available here: @@ -42,20 +41,8 @@ #endif #include "xsvf.h" - -#include "jtag.h" -#include "command.h" -#include "log.h" - -#include -#include -#include -#include -#include -#include - -#include -#include +#include +#include /* XSVF commands, from appendix B of xapp503.pdf */ @@ -95,7 +82,7 @@ ! Set the maximum loop count to 25. LCOUNT 25; -! Step to DRPAUSE give 5 clocks and wait for 1.00e+000 SEC. +! Step to DRPAUSE give 5 clocks and wait for 1.00e + 000 SEC. LDELAY DRPAUSE 5 TCK 1.00E-003 SEC; ! Test for the completed status. Match means pass. ! Loop back to LDELAY line if not match and loop count less than 25. @@ -107,6 +94,7 @@ LSDR 1 TDI (0) #define LCOUNT 0x19 #define LDELAY 0x1A #define LSDR 0x1B +#define XTRST 0x1C /* XSVF valid state values for the XSTATE command, from appendix B of xapp503.pdf */ @@ -127,20 +115,24 @@ LSDR 1 TDI (0) #define XSV_IREXIT2 0x0E #define XSV_IRUPDATE 0x0F +/* arguments to XTRST */ +#define XTRST_ON 0 +#define XTRST_OFF 1 +#define XTRST_Z 2 +#define XTRST_ABSENT 3 #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; -/* map xsvf tap state to an openocd "enum tap_state" */ -static tap_state_t xsvf_to_tap( int xsvf_state ) +/* map xsvf tap state to an openocd "tap_state_t" */ +static tap_state_t xsvf_to_tap(int xsvf_state) { tap_state_t ret; - switch( xsvf_state ) + switch (xsvf_state) { case XSV_RESET: ret = TAP_RESET; break; case XSV_IDLE: ret = TAP_IDLE; break; @@ -159,7 +151,7 @@ static tap_state_t xsvf_to_tap( int xsvf_state ) case XSV_IREXIT2: ret = TAP_IREXIT2; break; case XSV_IRUPDATE: ret = TAP_IRUPDATE; break; default: - LOG_ERROR( "UNKNOWN XSVF STATE 0x%02X", xsvf_state ); + LOG_ERROR("UNKNOWN XSVF STATE 0x%02X", xsvf_state); exit(1); } @@ -167,55 +159,8 @@ static tap_state_t xsvf_to_tap( int xsvf_state ) } -/* 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(). - */ -static void xsvf_add_statemove(tap_state_t state) -{ - tap_state_t moves[7]; /* max # of transitions */ - tap_state_t curstate = cmd_queue_cur_state; - int i; - u8 move = TAP_MOVE(cmd_queue_cur_state, state); - - if (state != TAP_RESET && state==cmd_queue_cur_state) - return; - - if(state==TAP_RESET) - { - jtag_add_tlr(); - return; - } - - for (i=0; i<7; i++) - { - int j = (move >> i) & 1; - if (j) - { - curstate = tap_transitions[curstate].high; - } - else - { - curstate = tap_transitions[curstate].low; - } - moves[i] = curstate; - } - - jtag_add_pathmove(7, moves); -} - -int xsvf_register_commands(struct command_context_s *cmd_ctx) -{ - register_command(cmd_ctx, NULL, "xsvf", handle_xsvf_command, - COMMAND_EXEC, "run xsvf [virt2]"); - - return ERROR_OK; -} - -static int xsvf_read_buffer(int num_bits, int fd, u8* buf) +static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf) { int num_bytes; @@ -230,43 +175,11 @@ static int xsvf_read_buffer(int num_bits, int fd, u8* buf) } -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, jtag_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) +COMMAND_HANDLER(handle_xsvf_command) { - 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; + uint8_t *dr_out_buf = NULL; /* from host to device (TDI) */ + uint8_t *dr_in_buf = NULL; /* from device to host (TDO) */ + uint8_t *dr_in_mask = NULL; int xsdrsize = 0; int xruntest = 0; /* number of TCK cycles OR microseconds */ @@ -275,8 +188,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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; + uint8_t opcode; + uint8_t uc; long file_offset = 0; int loop_count = 0; @@ -284,679 +197,804 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha int loop_clocks = 0; int loop_usecs = 0; - int do_abort = 0; - int unsupported = 0; - int tdo_mismatch = 0; - int result; + int do_abort = 0; + int unsupported = 0; + int tdo_mismatch = 0; + int result; + int verbose = 1; - 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) + if (CMD_ARGC < 2) { - command_print(cmd_ctx, "usage: xsvf "); + command_print(CMD_CTX, "usage: xsvf [] [quiet]"); return ERROR_FAIL; } - if (strcmp(args[0], "plain") != 0) + /* we mess with CMD_ARGV starting point below, snapshot filename here */ + const char *filename = CMD_ARGV[1]; + + if (strcmp(CMD_ARGV[0], "plain") != 0) { - tap = jtag_TapByString( args[0] ); - if (!tap ) + tap = jtag_tap_by_string(CMD_ARGV[0]); + if (!tap) { - command_print( cmd_ctx, "Tap: %s unknown", args[0] ); + command_print(CMD_CTX, "Tap: %s unknown", CMD_ARGV[0]); return ERROR_FAIL; } } - if ((xsvf_fd = open(args[1], O_RDONLY)) < 0) + if ((xsvf_fd = open(filename, O_RDONLY)) < 0) { - command_print(cmd_ctx, "file \"%s\" not found", args[1]); + 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)) + if ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "virt2") == 0)) { runtest_requires_tck = 1; + --CMD_ARGC; + ++CMD_ARGV; + } + + if ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "quiet") == 0)) + { + verbose = 0; } - LOG_USER("xsvf processing file: \"%s\"", args[1]); + LOG_USER("xsvf processing file: \"%s\"", filename); - while( read(xsvf_fd, &opcode, 1) > 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; - switch (opcode) - { - case XCOMPLETE: - LOG_DEBUG("XCOMPLETE"); + /* maybe collect another state for a pathmove(); + * or terminate a path. + */ + if (collecting_path) { + tap_state_t mystate; - result = jtag_execute_queue(); - if (result != ERROR_OK) + 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) { - tdo_mismatch = 1; + do_abort = 1; break; } - break; - case XTDOMASK: - LOG_DEBUG("XTDOMASK"); - if (dr_in_mask && (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_mask) != ERROR_OK)) + 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: + LOG_DEBUG("XCOMPLETE"); + + result = jtag_execute_queue(); + if (result != ERROR_OK) + { + tdo_mismatch = 1; break; + } + break; - case XRUNTEST: - { - u8 xruntest_buf[4]; + case XTDOMASK: + LOG_DEBUG("XTDOMASK"); + if (dr_in_mask && (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_mask) != ERROR_OK)) + do_abort = 1; + break; - if (read(xsvf_fd, xruntest_buf, 4) < 0) - { - do_abort = 1; - break; - } + case XRUNTEST: + { + uint8_t xruntest_buf[4]; - xruntest = be_to_h_u32(xruntest_buf); - LOG_DEBUG("XRUNTEST %d 0x%08X", xruntest, xruntest); + if (read(xsvf_fd, xruntest_buf, 4) < 0) + { + do_abort = 1; + break; } - break; - case XREPEAT: - { - u8 myrepeat; + xruntest = be_to_h_u32(xruntest_buf); + LOG_DEBUG("XRUNTEST %d 0x%08X", xruntest, xruntest); + } + break; - if (read(xsvf_fd, &myrepeat, 1) < 0) - do_abort = 1; - else - { - xrepeat = myrepeat; - LOG_DEBUG("XREPEAT %d", xrepeat ); - } + case XREPEAT: + { + uint8_t myrepeat; + + if (read(xsvf_fd, &myrepeat, 1) < 0) + do_abort = 1; + else + { + xrepeat = myrepeat; + LOG_DEBUG("XREPEAT %d", xrepeat); } - break; + } + break; + + case XSDRSIZE: + { + uint8_t xsdrsize_buf[4]; - case XSDRSIZE: + if (read(xsvf_fd, xsdrsize_buf, 4) < 0) { - u8 xsdrsize_buf[4]; + do_abort = 1; + break; + } - if (read(xsvf_fd, xsdrsize_buf, 4) < 0) - { - do_abort = 1; - break; - } + xsdrsize = be_to_h_u32(xsdrsize_buf); + LOG_DEBUG("XSDRSIZE %d", xsdrsize); - 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); - 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; - 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; - 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"); - 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 (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK) + if (opcode == XSDRTDO) + { + if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_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; - if (limit < 1) - limit = 1; + LOG_DEBUG("%s %d", op_name, xsdrsize); - LOG_DEBUG("%s %d", op_name, xsdrsize); + for (attempt = 0; attempt < limit; ++attempt) + { + struct scan_field field; - for( attempt=0; attempt 0) { - 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); - - 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; - } + /* 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(ARRAY_SIZE(exception_path), exception_path); + + if (verbose) + LOG_USER("%s mismatch, xsdrsize=%d retry=%d", op_name, xsdrsize, attempt); } - if (!matched) + field.num_bits = xsdrsize; + field.out_value = dr_out_buf; + field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1); + + if (tap == NULL) + jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, + TAP_DRPAUSE); + else + jtag_add_dr_scan(tap, 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) { - LOG_USER( "%s mismatch", op_name); - tdo_mismatch = 1; + matched = 1; break; } + } - /* See page 19 of XSVF spec regarding opcode "XSDR" */ - if (xruntest) - { - xsvf_add_statemove(TAP_IDLE); + if (!matched) + { + LOG_USER("%s mismatch", op_name); + tdo_mismatch = 1; + break; + } - 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); + /* See page 19 of XSVF spec regarding opcode "XSDR" */ + if (xruntest) + { + result = svf_add_statemove(TAP_IDLE); + + if (runtest_requires_tck) + jtag_add_clocks(xruntest); + else + jtag_add_sleep(xruntest); } - break; + else if (xendir != TAP_DRPAUSE) /* we are already in TAP_DRPAUSE */ + result = svf_add_statemove(xenddr); + } + break; - case XSETSDRMASKS: - LOG_ERROR("unsupported XSETSDRMASKS\n"); - unsupported = 1; - break; + case XSETSDRMASKS: + LOG_ERROR("unsupported XSETSDRMASKS\n"); + unsupported = 1; + break; - case XSDRINC: - LOG_ERROR("unsupported XSDRINC\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 XSDRB: + LOG_ERROR("unsupported XSDRB\n"); + unsupported = 1; + break; - case XSDRC: - LOG_ERROR("unsupported XSDRC\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 XSDRE: + LOG_ERROR("unsupported XSDRE\n"); + unsupported = 1; + break; - case XSDRTDOB: - LOG_ERROR("unsupported XSDRTDOB\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 XSDRTDOC: + LOG_ERROR("unsupported XSDRTDOC\n"); + unsupported = 1; + break; - case XSDRTDOE: - LOG_ERROR("unsupported XSDRTDOE\n"); - unsupported = 1; - break; + case XSDRTDOE: + LOG_ERROR("unsupported XSDRTDOE\n"); + unsupported = 1; + break; - case XSTATE: + case XSTATE: + { + tap_state_t mystate; + + if (read(xsvf_fd, &uc, 1) < 0) { - tap_state_t mystate; - tap_state_t *path; - int path_len; + do_abort = 1; + break; + } - if (read(xsvf_fd, &uc, 1) < 0) - { - do_abort = 1; - break; - } + mystate = xsvf_to_tap(uc); - mystate = xsvf_to_tap(uc); + LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate)); - LOG_DEBUG("XSTATE 0x%02X %s", uc, jtag_state_name(mystate) ); + if (mystate == TAP_INVALID) { + LOG_ERROR("XSVF: bad XSTATE %02x", uc); + do_abort = 1; + break; + } - path = calloc(XSTATE_MAX_PATH, 4); - path_len = 1; + /* NOTE: the current state is SVF-stable! */ - 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; ilasti) - { - 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); + /* no change == NOP */ + if (mystate == cmd_queue_cur_state + && mystate != TAP_RESET) + break; + + /* Hand off to SVF? */ + if (svf_tap_state_is_stable(mystate)) + { + 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; + + case XENDIR: + + if (read(xsvf_fd, &uc, 1) < 0) + { + do_abort = 1; + break; + } + + /* see page 22 of XSVF spec */ + if (uc == 0) + xendir = TAP_IDLE; + else if (uc == 1) + xendir = TAP_IRPAUSE; + else + { + LOG_ERROR("illegial XENDIR argument: 0x%02X", uc); + unsupported = 1; break; + } - case XENDIR: - { - tap_state_t mystate; + LOG_DEBUG("XENDIR 0x%02X %s", uc, tap_state_name(xendir)); + break; - if (read(xsvf_fd, &uc, 1) < 0) - { - do_abort = 1; - break; - } + case XENDDR: - /* see page 22 of XSVF spec */ - mystate = uc == 1 ? TAP_IRPAUSE : TAP_IDLE; + if (read(xsvf_fd, &uc, 1) < 0) + { + do_abort = 1; + break; + } + + /* see page 22 of XSVF spec */ + if (uc == 0) + xenddr = TAP_IDLE; + else if (uc == 1) + xenddr = TAP_DRPAUSE; + else + { + LOG_ERROR("illegial XENDDR argument: 0x%02X", uc); + unsupported = 1; + break; + } - LOG_DEBUG("XENDIR 0x%02X %s", uc, jtag_state_name(mystate)); + LOG_DEBUG("XENDDR %02X %s", uc, tap_state_name(xenddr)); + break; - /* 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 ) + case XSIR: + case XSIR2: + { + uint8_t short_buf[2]; + uint8_t* 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) { - LOG_ERROR("illegal XENDIR endstate: \"%s\"", jtag_state_name(mystate)); - unsupported = 1; + do_abort = 1; break; } - xendir = mystate; + bitcount = short_buf[0]; + LOG_DEBUG("XSIR %d", bitcount); } - break; - - case XENDDR: + else { - tap_state_t mystate; - - if (read(xsvf_fd, &uc, 1) < 0) + if (read(xsvf_fd, short_buf, 2) < 0) { do_abort = 1; break; } + bitcount = be_to_h_u16(short_buf); + LOG_DEBUG("XSIR2 %d", bitcount); + } - /* see page 22 of XSVF spec */ - mystate = uc == 1 ? TAP_DRPAUSE : TAP_IDLE; + ir_buf = malloc((bitcount + 7) / 8); - LOG_DEBUG("XENDDR %02X %s", uc, jtag_state_name(mystate)); + if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK) + do_abort = 1; + else + { + struct scan_field field; - if (mystate != TAP_IRPAUSE && mystate != TAP_DRPAUSE && mystate != TAP_RESET && mystate != TAP_IDLE ) - { - LOG_ERROR("illegal XENDDR endstate: \"%s\"", jtag_state_name( mystate )); - unsupported = 1; - break; - } - xenddr = mystate; - } - break; + field.num_bits = bitcount; + field.out_value = ir_buf; - case XSIR: - case XSIR2: - { - u8 short_buf[2]; - u8* ir_buf; - int bitcount; - tap_state_t my_end_state = xruntest ? TAP_IDLE : xendir; + field.in_value = NULL; - 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); - } + + + + if (tap == NULL) + jtag_add_plain_ir_scan(field.num_bits, + field.out_value, field.in_value, my_end_state); else + jtag_add_ir_scan(tap, &field, my_end_state); + + if (xruntest) { - if (read(xsvf_fd, short_buf, 2) < 0) - { - do_abort = 1; - break; - } - bitcount = be_to_h_u16(short_buf); - LOG_DEBUG("XSIR2 %d", bitcount); + if (runtest_requires_tck) + jtag_add_clocks(xruntest); + else + jtag_add_sleep(xruntest); } - ir_buf = malloc((bitcount+7) / 8); + /* 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. + */ - if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK) - do_abort = 1; - else + /* LOG_DEBUG("FLUSHING QUEUE"); */ + result = jtag_execute_queue(); + if (result != ERROR_OK) { - 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; - } + tdo_mismatch = 1; } - free(ir_buf); } - break; + free(ir_buf); + } + break; - case XCOMMENT: - { - int ndx = 0; - char comment[128]; + case XCOMMENT: + { + unsigned int ndx = 0; + char comment[128]; - do + do + { + if (read(xsvf_fd, &uc, 1) < 0) { - if (read(xsvf_fd, &uc, 1) < 0) - { - do_abort = 1; - break; - } + do_abort = 1; + break; + } - if ( ndx < sizeof(comment)-1 ) - comment[ndx++] = uc; + if (ndx < sizeof(comment)-1) + comment[ndx++] = uc; - } while (uc != 0); + } while (uc != 0); - comment[sizeof(comment)-1] = 0; /* regardless, terminate */ - LOG_USER(comment); - } - break; + comment[sizeof(comment)-1] = 0; /* regardless, terminate */ + if (verbose) + LOG_USER("# %s", comment); + } + break; - case XWAIT: - { - /* expected in stream: - XWAIT - */ + case XWAIT: + { + /* expected in stream: + XWAIT + */ - u8 wait; - u8 end; - u8 delay_buf[4]; + uint8_t wait; + uint8_t end; + uint8_t delay_buf[4]; - tap_state_t wait_state; - tap_state_t end_state; - int delay; + 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; - } + 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); + 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", jtag_state_name(wait_state), jtag_state_name(end_state), delay); + 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 ); - } + if (runtest_requires_tck && wait_state == TAP_IDLE) + { + jtag_add_runtest(delay, end_state); } - break; + else + { + /* FIXME handle statemove errors ... */ + result = svf_add_statemove(wait_state); + jtag_add_sleep(delay); + result = svf_add_statemove(end_state); + } + } + break; - case XWAITSTATE: + case XWAITSTATE: + { + /* expected in stream: + XWAITSTATE + */ + + uint8_t clock_buf[4]; + uint8_t usecs_buf[4]; + uint8_t wait; + uint8_t 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) { - /* expected in stream: - XWAITSTATE - */ - - 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; - } + do_abort = 1; + break; + } - wait_state = xsvf_to_tap( wait ); - end_state = xsvf_to_tap( end ); + 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); + clock_count = be_to_h_u32(clock_buf); + usecs = be_to_h_u32(usecs_buf); - LOG_DEBUG("XWAITSTATE %s %s clocks:%i usecs:%i", - jtag_state_name(wait_state), - jtag_state_name(end_state), - clock_count, usecs); + 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\"", jtag_state_name( wait_state )); - unsupported = 1; - } + /* 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 (!svf_tap_state_is_stable(wait_state)) + { + LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"", + tap_state_name(wait_state)); + unsupported = 1; + /* REVISIT "break" so we won't run? */ + } - xsvf_add_statemove( wait_state ); + /* FIXME handle statemove errors ... */ + result = svf_add_statemove(wait_state); - jtag_add_clocks( clock_count ); + jtag_add_clocks(clock_count); - jtag_add_sleep( usecs ); + jtag_add_sleep(usecs); - xsvf_add_statemove( end_state ); - } - break; + result = svf_add_statemove(end_state); + } + break; + + case LCOUNT: + { + /* expected in stream: + LCOUNT + */ + uint8_t count_buf[4]; - case LCOUNT: + if (read(xsvf_fd, count_buf, 4) < 0) { - /* expected in stream: - LCOUNT - */ - u8 count_buf[4]; + do_abort = 1; + break; + } - 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; - loop_count = be_to_h_u32(count_buf); - LOG_DEBUG("LCOUNT %d", loop_count); + case LDELAY: + { + /* expected in stream: + LDELAY + */ + uint8_t state; + uint8_t clock_buf[4]; + uint8_t 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; } - break; - case LDELAY: - { - /* expected in stream: - LDELAY - */ - 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; - } + /* 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); + + LOG_DEBUG("LDELAY %s clocks:%d usecs:%d", tap_state_name(loop_state), loop_clocks, loop_usecs); + } + break; - loop_state = xsvf_to_tap(state); - loop_clocks = be_to_h_u32(clock_buf); - loop_usecs = be_to_h_u32(usecs_buf); + /* 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("LDELAY %s clocks:%d usecs:%d", jtag_state_name(loop_state), loop_clocks, loop_usecs); + 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; } - break; - /* LSDR is more like XSDRTDO than it is like XSDR. It uses LDELAY which - * comes with clocks !AND! sleep requirements. - */ - case LSDR: + if (limit < 1) + limit = 1; + + for (attempt = 0; attempt < limit; ++attempt) { - int limit = loop_count; - int matched = 0; - int attempt; + struct scan_field field; - LOG_DEBUG("LSDR"); + result = svf_add_statemove(loop_state); + jtag_add_clocks(loop_clocks); + jtag_add_sleep(loop_usecs); - 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; - } + field.num_bits = xsdrsize; + field.out_value = dr_out_buf; + field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1); - if (limit < 1) - limit = 1; + if (attempt > 0 && verbose) + LOG_USER("LSDR retry %d", attempt); - for( attempt=0; attempt 0) - LOG_USER("LSDR retry %d", attempt); + free(field.in_value); - jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL); - if (tap == NULL) - jtag_add_plain_dr_scan(1, &field, loop_state); - else - jtag_add_dr_scan(1, &field, loop_state); - - /* LOG_DEBUG("FLUSHING QUEUE"); */ - result = jtag_execute_queue(); - if(result == ERROR_OK) - { - matched = 1; - break; - } - - jtag_add_clocks(loop_clocks); - jtag_add_sleep(loop_usecs); - } - if (!matched ) + /* LOG_DEBUG("FLUSHING QUEUE"); */ + result = jtag_execute_queue(); + if (result == ERROR_OK) { - LOG_USER( "LSDR mismatch" ); - tdo_mismatch = 1; + matched = 1; break; } } - break; - default: - LOG_ERROR("unknown xsvf command (0x%02X)\n", uc); - unsupported = 1; + if (!matched) + { + LOG_USER("LSDR mismatch"); + tdo_mismatch = 1; + break; + } + } + break; + + case XTRST: + { + uint8_t 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) @@ -964,16 +1002,16 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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(); + result = svf_add_statemove(TAP_IDLE); + result = jtag_execute_queue(); break; } } if (tdo_mismatch) { - command_print(cmd_ctx, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting", - file_offset ); + command_print(CMD_CTX, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting", + file_offset); return ERROR_FAIL; @@ -981,15 +1019,16 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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 ); + off_t offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1; + command_print(CMD_CTX, + "unsupported xsvf command (0x%02X) at offset %jd, aborting", + uc, (intmax_t)offset); return ERROR_FAIL; } if (do_abort) { - command_print(cmd_ctx, "premature end of xsvf file detected, aborting"); + command_print(CMD_CTX, "premature end of xsvf file detected, aborting"); return ERROR_FAIL; } @@ -1004,13 +1043,33 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha close(xsvf_fd); - command_print(cmd_ctx, "XSVF file programmed successfully"); + command_print(CMD_CTX, "XSVF file programmed successfully"); return ERROR_OK; } +static const struct command_registration xsvf_command_handlers[] = { + { + .name = "xsvf", + .handler = handle_xsvf_command, + .mode = COMMAND_EXEC, + .help = "Runs a XSVF file. If 'virt2' is given, xruntest " + "counts are interpreted as TCK cycles rather than " + "as microseconds. Without the 'quiet' option, all " + "comments, retries, and mismatches will be reported.", + .usage = "(tapname|'plain') filename ['virt2'] ['quiet']", + }, + COMMAND_REGISTRATION_DONE +}; + +int xsvf_register_commands(struct command_context *cmd_ctx) +{ + return register_commands(cmd_ctx, NULL, xsvf_command_handlers); +} + +#if 0 /* this comment style used to try and keep uncrustify from adding * at begin of line */ -/* PSUEDO-Code from Xilinx Appnote XAPP067.pdf: +PSUEDO-Code from Xilinx Appnote XAPP067.pdf: the following pseudo code clarifies the intent of the xrepeat support. The flow given is for the entire processing of an SVF file, not an XSVF file. @@ -1058,4 +1117,4 @@ else if RUNTEST record then store as end if -*/ +#endif