From f7772ccb490c3f26a17a0fd15a251ffc5f49e262 Mon Sep 17 00:00:00 2001 From: Spencer Oliver Date: Fri, 27 Jan 2012 16:47:48 +0000 Subject: [PATCH] build: cleanup src/xsvf directory Change-Id: I5325980b240fba841d8cce81985f4da369ad9052 Signed-off-by: Spencer Oliver Reviewed-on: http://openocd.zylin.com/410 Tested-by: jenkins --- src/xsvf/xsvf.c | 918 +++++++++++++++++++++++------------------------- src/xsvf/xsvf.h | 7 +- 2 files changed, 451 insertions(+), 474 deletions(-) diff --git a/src/xsvf/xsvf.c b/src/xsvf/xsvf.c index 5699d57fed..137dd63ac0 100644 --- a/src/xsvf/xsvf.c +++ b/src/xsvf/xsvf.c @@ -1,31 +1,31 @@ -/* - * 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: * http://www.asset-intertech.com/support/svf.pdf @@ -44,37 +44,36 @@ #include #include - /* XSVF commands, from appendix B of xapp503.pdf */ -#define XCOMPLETE 0x00 +#define XCOMPLETE 0x00 #define XTDOMASK 0x01 #define XSIR 0x02 #define XSDR 0x03 #define XRUNTEST 0x04 -#define XREPEAT 0x07 +#define XREPEAT 0x07 #define XSDRSIZE 0x08 -#define XSDRTDO 0x09 +#define XSDRTDO 0x09 #define XSETSDRMASKS 0x0A -#define XSDRINC 0x0B -#define XSDRB 0x0C -#define XSDRC 0x0D -#define XSDRE 0x0E +#define XSDRINC 0x0B +#define XSDRB 0x0C +#define XSDRC 0x0D +#define XSDRE 0x0E #define XSDRTDOB 0x0F #define XSDRTDOC 0x10 #define XSDRTDOE 0x11 -#define XSTATE 0x12 -#define XENDIR 0x13 -#define XENDDR 0x14 -#define XSIR2 0x15 +#define XSTATE 0x12 +#define XENDIR 0x13 +#define XENDDR 0x14 +#define XSIR2 0x15 #define XCOMMENT 0x16 -#define XWAIT 0x17 +#define XWAIT 0x17 /* XWAITSTATE is not in the xilinx XSVF spec, but the svf2xsvf.py translator * generates this. Arguably it is needed because the XSVF XRUNTEST command * was ill conceived and does not directly flow out of the SVF RUNTEST command. * This XWAITSTATE does map directly from the SVF RUNTEST command. */ -#define XWAITSTATE 0x18 +#define XWAITSTATE 0x18 /* Lattice has extended the SVF file format, and Dick Hollenbeck's python based * SVF2XSVF converter supports these 3 additional XSVF opcodes, LCOUNT, LDELAY, LSDR. @@ -88,84 +87,109 @@ LDELAY DRPAUSE 5 TCK 1.00E-003 SEC; ! Loop back to LDELAY line if not match and loop count less than 25. LSDR 1 TDI (0) - TDO (1); +TDO (1); */ -#define LCOUNT 0x19 -#define LDELAY 0x1A +#define LCOUNT 0x19 +#define LDELAY 0x1A #define LSDR 0x1B -#define XTRST 0x1C - +#define XTRST 0x1C /* XSVF valid state values for the XSTATE command, from appendix B of xapp503.pdf */ -#define XSV_RESET 0x00 +#define XSV_RESET 0x00 #define XSV_IDLE 0x01 #define XSV_DRSELECT 0x02 -#define XSV_DRCAPTURE 0x03 -#define XSV_DRSHIFT 0x04 -#define XSV_DREXIT1 0x05 -#define XSV_DRPAUSE 0x06 -#define XSV_DREXIT2 0x07 +#define XSV_DRCAPTURE 0x03 +#define XSV_DRSHIFT 0x04 +#define XSV_DREXIT1 0x05 +#define XSV_DRPAUSE 0x06 +#define XSV_DREXIT2 0x07 #define XSV_DRUPDATE 0x08 #define XSV_IRSELECT 0x09 -#define XSV_IRCAPTURE 0x0A -#define XSV_IRSHIFT 0x0B -#define XSV_IREXIT1 0x0C -#define XSV_IRPAUSE 0x0D -#define XSV_IREXIT2 0x0E +#define XSV_IRCAPTURE 0x0A +#define XSV_IRSHIFT 0x0B +#define XSV_IREXIT1 0x0C +#define XSV_IRPAUSE 0x0D +#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_OFF 1 +#define XTRST_Z 2 #define XTRST_ABSENT 3 #define XSTATE_MAX_PATH 12 - -static int xsvf_fd = 0; - +static int xsvf_fd; /* map xsvf tap state to an openocd "tap_state_t" */ static tap_state_t xsvf_to_tap(int xsvf_state) { - tap_state_t ret; + tap_state_t ret; - switch (xsvf_state) - { - case XSV_RESET: ret = TAP_RESET; break; - case XSV_IDLE: ret = TAP_IDLE; break; - case XSV_DRSELECT: ret = TAP_DRSELECT; break; - case XSV_DRCAPTURE: ret = TAP_DRCAPTURE; break; - case XSV_DRSHIFT: ret = TAP_DRSHIFT; break; - case XSV_DREXIT1: ret = TAP_DREXIT1; break; - case XSV_DRPAUSE: ret = TAP_DRPAUSE; break; - case XSV_DREXIT2: ret = TAP_DREXIT2; break; - case XSV_DRUPDATE: ret = TAP_DRUPDATE; break; - case XSV_IRSELECT: ret = TAP_IRSELECT; break; - case XSV_IRCAPTURE: ret = TAP_IRCAPTURE; break; - case XSV_IRSHIFT: ret = TAP_IRSHIFT; break; - case XSV_IREXIT1: ret = TAP_IREXIT1; break; - case XSV_IRPAUSE: ret = TAP_IRPAUSE; break; - case XSV_IREXIT2: ret = TAP_IREXIT2; break; - case XSV_IRUPDATE: ret = TAP_IRUPDATE; break; - default: - LOG_ERROR("UNKNOWN XSVF STATE 0x%02X", xsvf_state); - exit(1); + switch (xsvf_state) { + case XSV_RESET: + ret = TAP_RESET; + break; + case XSV_IDLE: + ret = TAP_IDLE; + break; + case XSV_DRSELECT: + ret = TAP_DRSELECT; + break; + case XSV_DRCAPTURE: + ret = TAP_DRCAPTURE; + break; + case XSV_DRSHIFT: + ret = TAP_DRSHIFT; + break; + case XSV_DREXIT1: + ret = TAP_DREXIT1; + break; + case XSV_DRPAUSE: + ret = TAP_DRPAUSE; + break; + case XSV_DREXIT2: + ret = TAP_DREXIT2; + break; + case XSV_DRUPDATE: + ret = TAP_DRUPDATE; + break; + case XSV_IRSELECT: + ret = TAP_IRSELECT; + break; + case XSV_IRCAPTURE: + ret = TAP_IRCAPTURE; + break; + case XSV_IRSHIFT: + ret = TAP_IRSHIFT; + break; + case XSV_IREXIT1: + ret = TAP_IREXIT1; + break; + case XSV_IRPAUSE: + ret = TAP_IRPAUSE; + break; + case XSV_IREXIT2: + ret = TAP_IREXIT2; + break; + case XSV_IRUPDATE: + ret = TAP_IRUPDATE; + break; + default: + LOG_ERROR("UNKNOWN XSVF STATE 0x%02X", xsvf_state); + exit(1); } return ret; } - - -static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf) +static int xsvf_read_buffer(int num_bits, int fd, uint8_t *buf) { int num_bytes; - for (num_bytes = (num_bits + 7) / 8; num_bytes > 0; num_bytes--) - { + for (num_bytes = (num_bits + 7) / 8; num_bytes > 0; num_bytes--) { /* reverse the order of bytes as they are read sequentially from file */ if (read(fd, buf + num_bytes - 1, 1) < 0) return ERROR_XSVF_EOF; @@ -174,7 +198,6 @@ static int xsvf_read_buffer(int num_bits, int fd, uint8_t* buf) return ERROR_OK; } - COMMAND_HANDLER(handle_xsvf_command) { uint8_t *dr_out_buf = NULL; /* from host to device (TDI) */ @@ -182,84 +205,77 @@ COMMAND_HANDLER(handle_xsvf_command) uint8_t *dr_in_mask = NULL; int xsdrsize = 0; - int xruntest = 0; /* number of TCK cycles OR microseconds */ - int xrepeat = 0; /* number of retries */ + 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 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 uc = 0; - long file_offset = 0; + uint8_t opcode; + uint8_t uc = 0; + long file_offset = 0; - int loop_count = 0; - tap_state_t loop_state = TAP_IDLE; - int loop_clocks = 0; - int loop_usecs = 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; + int do_abort = 0; + int unsupported = 0; + int tdo_mismatch = 0; + int result; + int verbose = 1; - bool collecting_path = false; - tap_state_t path[XSTATE_MAX_PATH]; - unsigned pathlen = 0; + 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; - + 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 + * additional devices in the scan chain, otherwise the device + * that should be affected */ struct jtag_tap *tap = NULL; if (CMD_ARGC < 2) - { return ERROR_COMMAND_SYNTAX_ERROR; - } /* we mess with CMD_ARGV starting point below, snapshot filename here */ const char *filename = CMD_ARGV[1]; - if (strcmp(CMD_ARGV[0], "plain") != 0) - { + if (strcmp(CMD_ARGV[0], "plain") != 0) { tap = jtag_tap_by_string(CMD_ARGV[0]); - if (!tap) - { + if (!tap) { command_print(CMD_CTX, "Tap: %s unknown", CMD_ARGV[0]); return ERROR_FAIL; } } - if ((xsvf_fd = open(filename, O_RDONLY)) < 0) - { + xsvf_fd = open(filename, O_RDONLY); + if (xsvf_fd < 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 ((CMD_ARGC > 2) && (strcmp(CMD_ARGV[2], "virt2") == 0)) - { + /* if this argument is present, then interpret xruntest counts as TCK cycles rather than as + *usecs */ + 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\"", filename); - while (read(xsvf_fd, &opcode, 1) > 0) - { + while (read(xsvf_fd, &opcode, 1) > 0) { /* record the position of this opcode within the file */ file_offset = lseek(xsvf_fd, 0, SEEK_CUR) - 1; @@ -267,105 +283,101 @@ COMMAND_HANDLER(handle_xsvf_command) * or terminate a path. */ if (collecting_path) { - tap_state_t mystate; + 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; + case XCOMMENT: + /* ignore/show comments between XSTATE ops */ break; - } - - if (read(xsvf_fd, &uc, 1) < 0) - { - do_abort = 1; - break; - } + case XSTATE: + /* try to collect another transition */ + if (pathlen == XSTATE_MAX_PATH) { + LOG_ERROR("XSVF: path too long"); + do_abort = 1; + break; + } - mystate = xsvf_to_tap(uc); - path[pathlen++] = mystate; + if (read(xsvf_fd, &uc, 1) < 0) { + do_abort = 1; + break; + } - LOG_DEBUG("XSTATE 0x%02X %s", uc, - tap_state_name(mystate)); + 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; + } - /* If path is incomplete, collect more */ - if (!svf_tap_state_is_stable(mystate)) - continue; + /* 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; - /* 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; - } + if (path[0] == TAP_RESET) + jtag_add_tlr(); + else + jtag_add_pathmove(pathlen, path); - /* 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; + result = jtag_execute_queue(); + if (result != ERROR_OK) { + LOG_ERROR("XSVF: pathmove error %d", result); + do_abort = 1; + break; + } + continue; + } + } - if (path[0] == TAP_RESET) - jtag_add_tlr(); - else - jtag_add_pathmove(pathlen, path); + switch (opcode) { + case XCOMPLETE: + LOG_DEBUG("XCOMPLETE"); result = jtag_execute_queue(); if (result != ERROR_OK) { - LOG_ERROR("XSVF: pathmove error %d", - result); - do_abort = 1; + tdo_mismatch = 1; break; } - continue; - } - } - - 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 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: + case XRUNTEST: { - uint8_t xruntest_buf[4]; + uint8_t xruntest_buf[4]; - if (read(xsvf_fd, xruntest_buf, 4) < 0) - { + if (read(xsvf_fd, xruntest_buf, 4) < 0) { do_abort = 1; break; } @@ -375,26 +387,24 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case XREPEAT: + case XREPEAT: { uint8_t myrepeat; if (read(xsvf_fd, &myrepeat, 1) < 0) do_abort = 1; - else - { + else { xrepeat = myrepeat; LOG_DEBUG("XREPEAT %d", xrepeat); } } break; - case XSDRSIZE: + case XSDRSIZE: { - uint8_t xsdrsize_buf[4]; + uint8_t xsdrsize_buf[4]; - if (read(xsvf_fd, xsdrsize_buf, 4) < 0) - { + if (read(xsvf_fd, xsdrsize_buf, 4) < 0) { do_abort = 1; break; } @@ -402,9 +412,12 @@ COMMAND_HANDLER(handle_xsvf_command) 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); @@ -412,25 +425,23 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case XSDR: /* these two are identical except for the dr_in_buf */ - case XSDRTDO: + case XSDR: /* these two are identical except for the dr_in_buf */ + case XSDRTDO: { int limit = xrepeat; - int matched = 0; + 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) - { + 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) - { + if (opcode == XSDRTDO) { + if (xsvf_read_buffer(xsdrsize, xsvf_fd, + dr_in_buf) != ERROR_OK) { do_abort = 1; break; } @@ -441,24 +452,22 @@ COMMAND_HANDLER(handle_xsvf_command) LOG_DEBUG("%s %d", op_name, xsdrsize); - for (attempt = 0; attempt < limit; ++attempt) - { + for (attempt = 0; attempt < limit; ++attempt) { struct scan_field field; - if (attempt > 0) - { + 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. - */ + * 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, @@ -471,7 +480,10 @@ COMMAND_HANDLER(handle_xsvf_command) jtag_add_pathmove(ARRAY_SIZE(exception_path), exception_path); if (verbose) - LOG_USER("%s mismatch, xsdrsize=%d retry=%d", op_name, xsdrsize, attempt); + LOG_USER("%s mismatch, xsdrsize=%d retry=%d", + op_name, + xsdrsize, + attempt); } field.num_bits = xsdrsize; @@ -479,7 +491,9 @@ COMMAND_HANDLER(handle_xsvf_command) 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, + 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); @@ -488,26 +502,22 @@ COMMAND_HANDLER(handle_xsvf_command) 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("%s mismatch", op_name); tdo_mismatch = 1; break; } /* See page 19 of XSVF spec regarding opcode "XSDR" */ - if (xruntest) - { + if (xruntest) { result = svf_add_statemove(TAP_IDLE); if (result != ERROR_OK) return result; @@ -525,52 +535,51 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case XSETSDRMASKS: - LOG_ERROR("unsupported XSETSDRMASKS"); - unsupported = 1; - break; + case XSETSDRMASKS: + LOG_ERROR("unsupported XSETSDRMASKS"); + unsupported = 1; + break; - case XSDRINC: - LOG_ERROR("unsupported XSDRINC"); - unsupported = 1; - break; + case XSDRINC: + LOG_ERROR("unsupported XSDRINC"); + unsupported = 1; + break; - case XSDRB: - LOG_ERROR("unsupported XSDRB"); - unsupported = 1; - break; + case XSDRB: + LOG_ERROR("unsupported XSDRB"); + unsupported = 1; + break; - case XSDRC: - LOG_ERROR("unsupported XSDRC"); - unsupported = 1; - break; + case XSDRC: + LOG_ERROR("unsupported XSDRC"); + unsupported = 1; + break; - case XSDRE: - LOG_ERROR("unsupported XSDRE"); - unsupported = 1; - break; + case XSDRE: + LOG_ERROR("unsupported XSDRE"); + unsupported = 1; + break; - case XSDRTDOB: - LOG_ERROR("unsupported XSDRTDOB"); - unsupported = 1; - break; + case XSDRTDOB: + LOG_ERROR("unsupported XSDRTDOB"); + unsupported = 1; + break; - case XSDRTDOC: - LOG_ERROR("unsupported XSDRTDOC"); - unsupported = 1; - break; + case XSDRTDOC: + LOG_ERROR("unsupported XSDRTDOC"); + unsupported = 1; + break; - case XSDRTDOE: - LOG_ERROR("unsupported XSDRTDOE"); - unsupported = 1; - break; + case XSDRTDOE: + LOG_ERROR("unsupported XSDRTDOE"); + unsupported = 1; + break; - case XSTATE: + case XSTATE: { - tap_state_t mystate; + tap_state_t mystate; - if (read(xsvf_fd, &uc, 1) < 0) - { + if (read(xsvf_fd, &uc, 1) < 0) { do_abort = 1; break; } @@ -593,8 +602,7 @@ COMMAND_HANDLER(handle_xsvf_command) break; /* Hand off to SVF? */ - if (svf_tap_state_is_stable(mystate)) - { + if (svf_tap_state_is_stable(mystate)) { result = svf_add_statemove(mystate); if (result != ERROR_OK) unsupported = 1; @@ -612,75 +620,66 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case XENDIR: + case XENDIR: - if (read(xsvf_fd, &uc, 1) < 0) - { - do_abort = 1; - break; - } + 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; + /* 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; + } + + LOG_DEBUG("XENDIR 0x%02X %s", uc, tap_state_name(xendir)); break; - } - LOG_DEBUG("XENDIR 0x%02X %s", uc, tap_state_name(xendir)); - break; + case XENDDR: - case XENDDR: + if (read(xsvf_fd, &uc, 1) < 0) { + do_abort = 1; + break; + } - 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; + } - /* 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; + LOG_DEBUG("XENDDR %02X %s", uc, tap_state_name(xenddr)); break; - } - LOG_DEBUG("XENDDR %02X %s", uc, tap_state_name(xenddr)); - break; - - case XSIR: - case XSIR2: + case XSIR: + case XSIR2: { - uint8_t short_buf[2]; - uint8_t* 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) - { + 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) - { + } else { + if (read(xsvf_fd, short_buf, 2) < 0) { do_abort = 1; break; } @@ -692,8 +691,7 @@ COMMAND_HANDLER(handle_xsvf_command) if (xsvf_read_buffer(bitcount, xsvf_fd, ir_buf) != ERROR_OK) do_abort = 1; - else - { + else { struct scan_field field; field.num_bits = bitcount; @@ -701,17 +699,13 @@ COMMAND_HANDLER(handle_xsvf_command) field.in_value = NULL; - - - 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 (xruntest) { if (runtest_requires_tck) jtag_add_clocks(xruntest); else @@ -726,23 +720,19 @@ COMMAND_HANDLER(handle_xsvf_command) /* LOG_DEBUG("FLUSHING QUEUE"); */ result = jtag_execute_queue(); if (result != ERROR_OK) - { tdo_mismatch = 1; - } } free(ir_buf); } break; - case XCOMMENT: + case XCOMMENT: { unsigned int ndx = 0; - char comment[128]; + char comment[128]; - do - { - if (read(xsvf_fd, &uc, 1) < 0) - { + do { + if (read(xsvf_fd, &uc, 1) < 0) { do_abort = 1; break; } @@ -758,40 +748,37 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case XWAIT: + case XWAIT: { /* expected in stream: XWAIT */ - uint8_t wait_local; - uint8_t end; - uint8_t 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_local, 1) < 0 - || read(xsvf_fd, &end, 1) < 0 - || read(xsvf_fd, delay_buf, 4) < 0) - { - do_abort = 1; - break; + || read(xsvf_fd, &end, 1) < 0 + || read(xsvf_fd, delay_buf, 4) < 0) { + do_abort = 1; + break; } wait_state = xsvf_to_tap(wait_local); end_state = xsvf_to_tap(end); - delay = be_to_h_u32(delay_buf); + 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); + 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 - { + else { /* FIXME handle statemove errors ... */ result = svf_add_statemove(wait_state); if (result != ERROR_OK) @@ -804,26 +791,26 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case XWAITSTATE: + case XWAITSTATE: { /* expected in stream: - XWAITSTATE + * XWAITSTATE + * */ - uint8_t clock_buf[4]; - uint8_t usecs_buf[4]; - uint8_t wait_local; - uint8_t 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_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, &end, 1) < 0 + || read(xsvf_fd, clock_buf, 4) < 0 + || read(xsvf_fd, usecs_buf, 4) < 0) { do_abort = 1; break; } @@ -832,20 +819,19 @@ COMMAND_HANDLER(handle_xsvf_command) end_state = xsvf_to_tap(end); clock_count = be_to_h_u32(clock_buf); - usecs = be_to_h_u32(usecs_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); + 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 (!svf_tap_state_is_stable(wait_state)) - { + if (!svf_tap_state_is_stable(wait_state)) { LOG_ERROR("illegal XWAITSTATE wait_state: \"%s\"", tap_state_name(wait_state)); unsupported = 1; @@ -858,7 +844,6 @@ COMMAND_HANDLER(handle_xsvf_command) return result; jtag_add_clocks(clock_count); - jtag_add_sleep(usecs); result = svf_add_statemove(end_state); @@ -867,15 +852,14 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case LCOUNT: + case LCOUNT: { /* expected in stream: - LCOUNT + * LCOUNT */ - uint8_t 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; } @@ -885,19 +869,18 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case LDELAY: + case LDELAY: { /* expected in stream: - LDELAY + * LDELAY */ - uint8_t state; - uint8_t clock_buf[4]; - uint8_t usecs_buf[4]; + 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) - { + || read(xsvf_fd, clock_buf, 4) < 0 + || read(xsvf_fd, usecs_buf, 4) < 0) { do_abort = 1; break; } @@ -907,14 +890,15 @@ COMMAND_HANDLER(handle_xsvf_command) 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); + 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: + /* 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; @@ -923,8 +907,7 @@ COMMAND_HANDLER(handle_xsvf_command) 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) - { + || xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK) { do_abort = 1; break; } @@ -932,8 +915,7 @@ COMMAND_HANDLER(handle_xsvf_command) if (limit < 1) limit = 1; - for (attempt = 0; attempt < limit; ++attempt) - { + for (attempt = 0; attempt < limit; ++attempt) { struct scan_field field; result = svf_add_statemove(loop_state); @@ -950,7 +932,9 @@ COMMAND_HANDLER(handle_xsvf_command) LOG_USER("LSDR retry %d", attempt); if (tap == NULL) - jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, + 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); @@ -962,15 +946,13 @@ COMMAND_HANDLER(handle_xsvf_command) /* 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"); tdo_mismatch = 1; break; @@ -978,18 +960,16 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - case XTRST: + case XTRST: { - uint8_t trst_mode; + uint8_t trst_mode; - if (read(xsvf_fd, &trst_mode, 1) < 0) - { + if (read(xsvf_fd, &trst_mode, 1) < 0) { do_abort = 1; break; } - switch (trst_mode) - { + switch (trst_mode) { case XTRST_ON: jtag_add_reset(1, 0); break; @@ -1006,13 +986,12 @@ COMMAND_HANDLER(handle_xsvf_command) } break; - default: - LOG_ERROR("unknown xsvf command (0x%02X)", uc); - unsupported = 1; + default: + LOG_ERROR("unknown xsvf command (0x%02X)", uc); + unsupported = 1; } - if (do_abort || unsupported || tdo_mismatch) - { + if (do_abort || unsupported || tdo_mismatch) { LOG_DEBUG("xsvf failed, setting taps to reasonable state"); /* upon error, return the TAPs to a reasonable state */ @@ -1026,26 +1005,23 @@ COMMAND_HANDLER(handle_xsvf_command) } } - if (tdo_mismatch) - { - command_print(CMD_CTX, "TDO mismatch, somewhere near offset %lu in xsvf file, aborting", - file_offset); - + if (tdo_mismatch) { + command_print(CMD_CTX, + "TDO mismatch, somewhere near offset %lu in xsvf file, aborting", + file_offset); return ERROR_FAIL; } - if (unsupported) - { + if (unsupported) { 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); + "unsupported xsvf command (0x%02X) at offset %jd, aborting", + uc, (intmax_t)offset); return ERROR_FAIL; } - if (do_abort) - { + if (do_abort) { command_print(CMD_CTX, "premature end of xsvf file detected, aborting"); return ERROR_FAIL; } @@ -1085,11 +1061,11 @@ 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 +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. No idea if this is just for the XC9500/XL/XV devices or all Xilinx parts. @@ -1100,39 +1076,39 @@ No idea if this is just for the XC9500/XL/XV devices or all Xilinx parts. 3. Read SVF record 4. if SIR record then - go to Shift-IR state - Scan in +go to Shift-IR state +Scan in 5. else if SDR record then - set to 0 - store as - store as +set to 0 +store as +store as 6. go to Shift-DR state - scan in - if is specified then - if does not equal then - if > 32 then - LOG ERROR - go to Run-Test Idle state - go to Step 3 - end if - go to Pause-DR - go to Exit2-DR - go to Shift-DR - go to Exit1-DR - go to Update-DR - go to Run-Test/Idle - increment by 1 - pause microseconds - go to Step 6) - end if - else - go to Run-Test Idle state - go to Step 3 - endif -else if RUNTEST record then - pause tester for microseconds - store as +scan in +if < current TDO value > is specified then +if < current TDO value > does not equal then +if < repeat count > > 32 then +LOG ERROR +go to Run-Test Idle state +go to Step 3 +end if +go to Pause-DR +go to Exit2-DR +go to Shift-DR +go to Exit1-DR +go to Update-DR +go to Run-Test/Idle +increment by 1 +pause microseconds +go to Step 6) end if +else + go to Run-Test Idle state + go to Step 3 + endif + else if RUNTEST record then + pause tester for < TCK value > microseconds + store as + end if -#endif +*/ diff --git a/src/xsvf/xsvf.h b/src/xsvf/xsvf.h index 7ce3711337..508e603cce 100644 --- a/src/xsvf/xsvf.h +++ b/src/xsvf/xsvf.h @@ -17,6 +17,7 @@ * Free Software Foundation, Inc., * * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. * ***************************************************************************/ + #ifndef XSVF_H #define XSVF_H @@ -24,7 +25,7 @@ int xsvf_register_commands(struct command_context *cmd_ctx); -#define ERROR_XSVF_EOF (-200) -#define ERROR_XSVF_FAILED (-201) +#define ERROR_XSVF_EOF (-200) +#define ERROR_XSVF_FAILED (-201) -#endif /* XSVF_H */ +#endif /* XSVF_H */ -- 2.30.2