X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fxsvf%2Fxsvf.c;h=31c39499380c494dbd71d6df9bbd9137abe43193;hp=17dec493891b8c75392ac82a5e5a185cc2dd11ae;hb=a665ef716a9a90c30fb15e1f979845b3438a7251;hpb=b4fbd4abe47f2dd3d3e94091430cbf765f36f5df diff --git a/src/xsvf/xsvf.c b/src/xsvf/xsvf.c index 17dec49389..31c3949938 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 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. * - ***************************************************************************/ +/* + * 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,21 +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 +#include /* XSVF commands, from appendix B of xapp503.pdf */ @@ -96,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. @@ -137,17 +123,16 @@ LSDR 1 TDI (0) #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 "tap_state_t" */ -static tap_state_t xsvf_to_tap( int xsvf_state ) +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; @@ -166,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); } @@ -174,61 +159,8 @@ static tap_state_t xsvf_to_tap( int xsvf_state ) } -/** - * Function xsvf_add_statemove - * moves from the current state to the goal \a state. 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 goal_state) -{ - tap_state_t moves[8]; - tap_state_t cur_state = cmd_queue_cur_state; - int i; - int tms_bits; - int tms_count; - - LOG_DEBUG( "cur_state=%s goal_state=%s", - tap_state_name(cur_state), - tap_state_name(goal_state) ); - - if (goal_state==cur_state ) - return; - - if( goal_state==TAP_RESET ) - { - jtag_add_tlr(); - return; - } - - 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>=1) - { - bool bit = tms_bits & 1; - - cur_state = tap_state_transition(cur_state, bit); - moves[i] = cur_state; - } - - jtag_add_pathmove(tms_count, 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] [quiet]"); - - 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; @@ -243,11 +175,11 @@ static int xsvf_read_buffer(int num_bits, int fd, u8* buf) } -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 */ @@ -256,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; @@ -265,66 +197,151 @@ 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; - 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) + if (CMD_ARGC < 2) { - command_print(cmd_ctx, "usage: xsvf [] [quiet]"); + command_print(CMD_CTX, "usage: xsvf [] [quiet]"); return ERROR_FAIL; } - filename = args[1]; /* we mess with args starting point below, snapshot filename here */ + /* we mess with CMD_ARGV starting point below, snapshot filename here */ + const char *filename = CMD_ARGV[1]; - if (strcmp(args[0], "plain") != 0) + 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(filename, O_RDONLY)) < 0) { - command_print(cmd_ctx, "file \"%s\" not found", filename); + 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; - --argc; - ++args; + --CMD_ARGC; + ++CMD_ARGV; } - if ((argc > 2) && (strcmp(args[2], "quiet") == 0)) + if ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "quiet") == 0)) { verbose = 0; } 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; + /* maybe collect another state for a pathmove(); + * or terminate a path. + */ + if (collecting_path) { + tap_state_t mystate; + + 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_execute_queue(); + if (result != ERROR_OK) { + LOG_ERROR("XSVF: pathmove error %d", + result); + do_abort = 1; + break; + } + continue; + } + } + switch (opcode) { case XCOMPLETE: @@ -346,7 +363,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XRUNTEST: { - u8 xruntest_buf[4]; + uint8_t xruntest_buf[4]; if (read(xsvf_fd, xruntest_buf, 4) < 0) { @@ -361,21 +378,21 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XREPEAT: { - u8 myrepeat; + uint8_t myrepeat; if (read(xsvf_fd, &myrepeat, 1) < 0) do_abort = 1; else { xrepeat = myrepeat; - LOG_DEBUG("XREPEAT %d", xrepeat ); + LOG_DEBUG("XREPEAT %d", xrepeat); } } break; case XSDRSIZE: { - u8 xsdrsize_buf[4]; + uint8_t xsdrsize_buf[4]; if (read(xsvf_fd, xsdrsize_buf, 4) < 0) { @@ -386,9 +403,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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); @@ -413,7 +430,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (opcode == XSDRTDO) { - if(xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK ) + if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK) { do_abort = 1; break; @@ -425,11 +442,11 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_DEBUG("%s %d", op_name, xsdrsize); - for( attempt=0; attempt0 ) + 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 @@ -452,24 +469,26 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha TAP_IDLE, }; - jtag_add_pathmove( DIM(exception_path), exception_path ); + jtag_add_pathmove(ARRAY_SIZE(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.in_value = NULL; - - jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL); + field.in_value = calloc(DIV_ROUND_UP(field.num_bits, 8), 1); if (tap == NULL) - jtag_add_plain_dr_scan(1, &field, TAP_DRPAUSE); + jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, + TAP_DRPAUSE); else - jtag_add_dr_scan(1, &field, TAP_DRPAUSE); + 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(); @@ -482,7 +501,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (!matched) { - LOG_USER( "%s mismatch", op_name); + LOG_USER("%s mismatch", op_name); tdo_mismatch = 1; break; } @@ -490,7 +509,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha /* See page 19 of XSVF spec regarding opcode "XSDR" */ if (xruntest) { - xsvf_add_statemove(TAP_IDLE); + result = svf_add_statemove(TAP_IDLE); if (runtest_requires_tck) jtag_add_clocks(xruntest); @@ -498,54 +517,53 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha jtag_add_sleep(xruntest); } else if (xendir != TAP_DRPAUSE) /* we are already in TAP_DRPAUSE */ - xsvf_add_statemove(xenddr); + result = svf_add_statemove(xenddr); } break; case XSETSDRMASKS: - LOG_ERROR("unsupported XSETSDRMASKS\n"); + LOG_ERROR("unsupported XSETSDRMASKS"); unsupported = 1; break; case XSDRINC: - LOG_ERROR("unsupported XSDRINC\n"); + LOG_ERROR("unsupported XSDRINC"); unsupported = 1; break; case XSDRB: - LOG_ERROR("unsupported XSDRB\n"); + LOG_ERROR("unsupported XSDRB"); unsupported = 1; break; case XSDRC: - LOG_ERROR("unsupported XSDRC\n"); + LOG_ERROR("unsupported XSDRC"); unsupported = 1; break; case XSDRE: - LOG_ERROR("unsupported XSDRE\n"); + LOG_ERROR("unsupported XSDRE"); unsupported = 1; break; case XSDRTDOB: - LOG_ERROR("unsupported XSDRTDOB\n"); + LOG_ERROR("unsupported XSDRTDOB"); unsupported = 1; break; case XSDRTDOC: - LOG_ERROR("unsupported XSDRTDOC\n"); + LOG_ERROR("unsupported XSDRTDOC"); unsupported = 1; break; case XSDRTDOE: - LOG_ERROR("unsupported XSDRTDOE\n"); + LOG_ERROR("unsupported XSDRTDOE"); unsupported = 1; break; case XSTATE: { tap_state_t mystate; - u8 uc; if (read(xsvf_fd, &uc, 1) < 0) { @@ -555,9 +573,38 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha mystate = xsvf_to_tap(uc); - LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate) ); + LOG_DEBUG("XSTATE 0x%02X %s", uc, tap_state_name(mystate)); + + if (mystate == TAP_INVALID) { + LOG_ERROR("XSVF: bad XSTATE %02x", uc); + do_abort = 1; + break; + } + + /* NOTE: the current state is SVF-stable! */ - xsvf_add_statemove( mystate ); + /* 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; @@ -570,9 +617,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha } /* see page 22 of XSVF spec */ - if( uc == 0 ) + if (uc == 0) xendir = TAP_IDLE; - else if( uc == 1 ) + else if (uc == 1) xendir = TAP_IRPAUSE; else { @@ -593,9 +640,9 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha } /* see page 22 of XSVF spec */ - if( uc == 0 ) + if (uc == 0) xenddr = TAP_IDLE; - else if( uc == 1 ) + else if (uc == 1) xenddr = TAP_DRPAUSE; else { @@ -610,12 +657,12 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XSIR: case XSIR2: { - u8 short_buf[2]; - u8* ir_buf; + uint8_t short_buf[2]; + uint8_t* ir_buf; int bitcount; tap_state_t my_end_state = xruntest ? TAP_IDLE : xendir; - if( opcode == XSIR ) + if (opcode == XSIR) { /* one byte bitcount */ if (read(xsvf_fd, short_buf, 1) < 0) @@ -637,27 +684,27 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha LOG_DEBUG("XSIR2 %d", bitcount); } - ir_buf = malloc((bitcount+7) / 8); + 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; + struct scan_field field; - field.tap = tap; field.num_bits = bitcount; field.out_value = ir_buf; - + field.in_value = NULL; - - - field.in_handler = NULL; + + + if (tap == NULL) - jtag_add_plain_ir_scan(1, &field, my_end_state); + jtag_add_plain_ir_scan(field.num_bits, + field.out_value, field.in_value, my_end_state); else - jtag_add_ir_scan(1, &field, my_end_state); + jtag_add_ir_scan(tap, &field, my_end_state); if (xruntest) { @@ -674,7 +721,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); - if(result != ERROR_OK) + if (result != ERROR_OK) { tdo_mismatch = 1; } @@ -686,7 +733,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XCOMMENT: { unsigned int ndx = 0; - char comment[128]; + char comment[128]; do { @@ -696,32 +743,32 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha break; } - if ( ndx < sizeof(comment)-1 ) + if (ndx < sizeof(comment)-1) comment[ndx++] = uc; } while (uc != 0); comment[sizeof(comment)-1] = 0; /* regardless, terminate */ if (verbose) - LOG_USER("\"# %s\"", comment); + LOG_USER("# %s", comment); } break; case XWAIT: { /* expected in stream: - XWAIT + XWAIT */ - u8 wait; - u8 end; - u8 delay_buf[4]; + uint8_t wait_local; + uint8_t end; + uint8_t delay_buf[4]; tap_state_t wait_state; tap_state_t end_state; - int delay; + int delay; - if ( read(xsvf_fd, &wait, 1) < 0 + if (read(xsvf_fd, &wait_local, 1) < 0 || read(xsvf_fd, &end, 1) < 0 || read(xsvf_fd, delay_buf, 4) < 0) { @@ -729,21 +776,22 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha break; } - wait_state = xsvf_to_tap(wait); + wait_state = xsvf_to_tap(wait_local); 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 ) + if (runtest_requires_tck && wait_state == TAP_IDLE) { jtag_add_runtest(delay, end_state); } else { - xsvf_add_statemove( wait_state ); + /* FIXME handle statemove errors ... */ + result = svf_add_statemove(wait_state); jtag_add_sleep(delay); - xsvf_add_statemove( end_state ); + result = svf_add_statemove(end_state); } } break; @@ -751,29 +799,29 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XWAITSTATE: { /* expected in stream: - XWAITSTATE + XWAITSTATE */ - u8 clock_buf[4]; - u8 usecs_buf[4]; - u8 wait; - u8 end; + uint8_t clock_buf[4]; + uint8_t usecs_buf[4]; + uint8_t wait_local; + 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 + if (read(xsvf_fd, &wait_local, 1) < 0 || read(xsvf_fd, &end, 1) < 0 || read(xsvf_fd, clock_buf, 4) < 0 - || read(xsvf_fd, usecs_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 ); + wait_state = xsvf_to_tap(wait_local); + end_state = xsvf_to_tap(end); clock_count = be_to_h_u32(clock_buf); usecs = be_to_h_u32(usecs_buf); @@ -788,30 +836,33 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha * 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? */ } - 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 ); + result = svf_add_statemove(end_state); } break; case LCOUNT: { /* expected in stream: - LCOUNT + LCOUNT */ - u8 count_buf[4]; + uint8_t count_buf[4]; - if ( read(xsvf_fd, count_buf, 4) < 0 ) + if (read(xsvf_fd, count_buf, 4) < 0) { do_abort = 1; break; @@ -825,20 +876,21 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case LDELAY: { /* expected in stream: - LDELAY + LDELAY */ - u8 state; - u8 clock_buf[4]; - u8 usecs_buf[4]; + uint8_t state; + uint8_t clock_buf[4]; + uint8_t usecs_buf[4]; - if ( read(xsvf_fd, &state, 1) < 0 + if (read(xsvf_fd, &state, 1) < 0 || read(xsvf_fd, clock_buf, 4) < 0 - || read(xsvf_fd, usecs_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); @@ -858,8 +910,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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 ) + 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; @@ -868,41 +920,44 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (limit < 1) limit = 1; - for( attempt=0; 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); + jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, + TAP_DRPAUSE); else - jtag_add_dr_scan(1, &field, TAP_DRPAUSE); + 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) + if (result == ERROR_OK) { matched = 1; break; } } - if (!matched ) + if (!matched) { - LOG_USER( "LSDR mismatch" ); + LOG_USER("LSDR mismatch"); tdo_mismatch = 1; break; } @@ -911,7 +966,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XTRST: { - u8 trst_mode; + uint8_t trst_mode; if (read(xsvf_fd, &trst_mode, 1) < 0) { @@ -919,7 +974,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha break; } - switch( trst_mode ) + switch (trst_mode) { case XTRST_ON: jtag_add_reset(1, 0); @@ -931,14 +986,14 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha case XTRST_ABSENT: break; default: - LOG_ERROR( "XTRST mode argument (0x%02X) out of range", trst_mode ); + 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); + LOG_ERROR("unknown xsvf command (0x%02X)", uc); unsupported = 1; } @@ -947,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; @@ -964,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; } @@ -987,11 +1043,29 @@ 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 */