X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fxsvf%2Fxsvf.c;h=f2c1a4220a2a0eec8aa2110a7d0f5a50e09fbdef;hp=683b8e29f046bd1db03052387835d0181c3f3db0;hb=50dc56a488c6e4d5acdfd73f12e3502e1586c51e;hpb=c97caebccd07be7e5bae61d6d40921e01786ba06 diff --git a/src/xsvf/xsvf.c b/src/xsvf/xsvf.c index 683b8e29f0..f2c1a4220a 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,7 +41,8 @@ #endif #include "xsvf.h" -#include "jtag.h" +#include +#include /* XSVF commands, from appendix B of xapp503.pdf */ @@ -123,7 +123,6 @@ 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; @@ -161,14 +160,6 @@ static tap_state_t xsvf_to_tap(int xsvf_state) -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, uint8_t* buf) { int num_bytes; @@ -184,9 +175,9 @@ static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf) } -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_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; @@ -197,7 +188,7 @@ 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; - uint8_t opcode; + uint8_t opcode; uint8_t uc; long file_offset = 0; @@ -206,55 +197,62 @@ 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_tap_by_string(args[0]); + 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; } @@ -263,9 +261,88 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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: @@ -368,7 +445,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha for (attempt = 0; attempt < limit; ++attempt) { - scan_field_t field; + struct scan_field field; if (attempt > 0) { @@ -393,21 +470,21 @@ 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 = 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)); + jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, + jtag_set_end_state(TAP_DRPAUSE)); else - jtag_add_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE)); + jtag_add_dr_scan(tap, 1, &field, jtag_set_end_state(TAP_DRPAUSE)); jtag_check_value_mask(&field, dr_in_buf, dr_in_mask); @@ -433,7 +510,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) { - jtag_add_statemove(TAP_IDLE); + result = svf_add_statemove(TAP_IDLE); if (runtest_requires_tck) jtag_add_clocks(xruntest); @@ -441,7 +518,7 @@ 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 */ - jtag_add_statemove(xenddr); + result = svf_add_statemove(xenddr); } break; @@ -500,32 +577,36 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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; @@ -611,9 +692,8 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha do_abort = 1; else { - scan_field_t field; + struct scan_field field; - field.tap = tap; field.num_bits = bitcount; field.out_value = ir_buf; @@ -623,9 +703,10 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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) { @@ -654,7 +735,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 { @@ -687,7 +768,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha tap_state_t wait_state; tap_state_t end_state; - int delay; + int delay; if (read(xsvf_fd, &wait, 1) < 0 || read(xsvf_fd, &end, 1) < 0 @@ -709,9 +790,10 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha } 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; @@ -723,7 +805,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha */ uint8_t clock_buf[4]; - uint8_t usecs_buf[4]; + uint8_t usecs_buf[4]; uint8_t wait; uint8_t end; tap_state_t wait_state; @@ -756,19 +838,22 @@ 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? */ } - 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; @@ -807,6 +892,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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); @@ -838,24 +924,24 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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); if (tap == NULL) - jtag_add_plain_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE)); + jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, + jtag_set_end_state(TAP_DRPAUSE)); else - jtag_add_dr_scan(1, &field, jtag_set_end_state(TAP_DRPAUSE)); + jtag_add_dr_scan(tap, 1, &field, jtag_set_end_state(TAP_DRPAUSE)); jtag_check_value_mask(&field, dr_in_buf, dr_in_mask); @@ -918,15 +1004,15 @@ 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 */ - jtag_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", + command_print(CMD_CTX, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting", file_offset); @@ -936,7 +1022,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha if (unsupported) { off_t offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1; - command_print(cmd_ctx, + command_print(CMD_CTX, "unsupported xsvf command (0x%02X) at offset %jd, aborting", uc, (intmax_t)offset); return ERROR_FAIL; @@ -944,7 +1030,7 @@ static int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, cha 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; } @@ -959,11 +1045,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 */