git.gag.com Git - fw/openocd/blob - src/svf/svf.c

   1 /***************************************************************************
   2  *    Copyright (C) 2009 by Simon Qian                                     *
   3  *    SimonQian@SimonQian.com                                              *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  17  ***************************************************************************/
  18
  19 /* The specification for SVF is available here:
  20  * http://www.asset-intertech.com/support/svf.pdf
  21  * Below, this document is referred to as the "SVF spec".
  22  *
  23  * The specification for XSVF is available here:
  24  * http://www.xilinx.com/support/documentation/application_notes/xapp503.pdf
  25  * Below, this document is referred to as the "XSVF spec".
  26  */
  27
  28 #ifdef HAVE_CONFIG_H
  29 #include "config.h"
  30 #endif
  31
  32 #include <jtag/jtag.h>
  33 #include "svf.h"
  34 #include "helper/system.h"
  35 #include <helper/time_support.h>
  36
  37 /* SVF command */
  38 enum svf_command {
  39         ENDDR,
  40         ENDIR,
  41         FREQUENCY,
  42         HDR,
  43         HIR,
  44         PIO,
  45         PIOMAP,
  46         RUNTEST,
  47         SDR,
  48         SIR,
  49         STATE,
  50         TDR,
  51         TIR,
  52         TRST,
  53 };
  54
  55 static const char *svf_command_name[14] = {
  56         "ENDDR",
  57         "ENDIR",
  58         "FREQUENCY",
  59         "HDR",
  60         "HIR",
  61         "PIO",
  62         "PIOMAP",
  63         "RUNTEST",
  64         "SDR",
  65         "SIR",
  66         "STATE",
  67         "TDR",
  68         "TIR",
  69         "TRST"
  70 };
  71
  72 enum trst_mode {
  73         TRST_ON,
  74         TRST_OFF,
  75         TRST_Z,
  76         TRST_ABSENT
  77 };
  78
  79 static const char *svf_trst_mode_name[4] = {
  80         "ON",
  81         "OFF",
  82         "Z",
  83         "ABSENT"
  84 };
  85
  86 struct svf_statemove {
  87         tap_state_t from;
  88         tap_state_t to;
  89         uint32_t num_of_moves;
  90         tap_state_t paths[8];
  91 };
  92
  93 /*
  94  * These paths are from the SVF specification for the STATE command, to be
  95  * used when the STATE command only includes the final state.  The first
  96  * element of the path is the "from" (current) state, and the last one is
  97  * the "to" (target) state.
  98  *
  99  * All specified paths are the shortest ones in the JTAG spec, and are thus
 100  * not (!!) exact matches for the paths used elsewhere in OpenOCD.  Note
 101  * that PAUSE-to-PAUSE transitions all go through UPDATE and then CAPTURE,
 102  * which has specific effects on the various registers; they are not NOPs.
 103  *
 104  * Paths to RESET are disabled here.  As elsewhere in OpenOCD, and in XSVF
 105  * and many SVF implementations, we don't want to risk missing that state.
 106  * To get to RESET, always we ignore the current state.
 107  */
 108 static const struct svf_statemove svf_statemoves[] = {
 109         /* from                 to                              num_of_moves,   paths[8] */
 110 /*      {TAP_RESET,             TAP_RESET,              1,                              {TAP_RESET}}, */
 111         {TAP_RESET,             TAP_IDLE,               2,                              {TAP_RESET, TAP_IDLE} },
 112         {TAP_RESET,             TAP_DRPAUSE,    6,                              {TAP_RESET, TAP_IDLE, TAP_DRSELECT,
 113                                                                                                                 TAP_DRCAPTURE, TAP_DREXIT1, TAP_DRPAUSE} },
 114         {TAP_RESET,             TAP_IRPAUSE,    7,                              {TAP_RESET, TAP_IDLE, TAP_DRSELECT,
 115                                                                                                                 TAP_IRSELECT, TAP_IRCAPTURE,
 116                                                                                                                 TAP_IREXIT1, TAP_IRPAUSE} },
 117
 118 /*      {TAP_IDLE,              TAP_RESET,              4,                              {TAP_IDLE,
 119  * TAP_DRSELECT, TAP_IRSELECT, TAP_RESET}}, */
 120         {TAP_IDLE,              TAP_IDLE,               1,                              {TAP_IDLE} },
 121         {TAP_IDLE,              TAP_DRPAUSE,    5,                              {TAP_IDLE, TAP_DRSELECT, TAP_DRCAPTURE,
 122                                                                                                                 TAP_DREXIT1, TAP_DRPAUSE} },
 123         {TAP_IDLE,              TAP_IRPAUSE,    6,                              {TAP_IDLE, TAP_DRSELECT, TAP_IRSELECT,
 124                                                                                                                 TAP_IRCAPTURE, TAP_IREXIT1, TAP_IRPAUSE} },
 125
 126 /*      {TAP_DRPAUSE,   TAP_RESET,              6,                              {TAP_DRPAUSE,
 127  * TAP_DREXIT2, TAP_DRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_RESET}}, */
 128         {TAP_DRPAUSE,   TAP_IDLE,               4,                              {TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE,
 129                                                                                                                 TAP_IDLE} },
 130         {TAP_DRPAUSE,   TAP_DRPAUSE,    7,                              {TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE,
 131                                                                                                                 TAP_DRSELECT, TAP_DRCAPTURE,
 132                                                                                                                 TAP_DREXIT1, TAP_DRPAUSE} },
 133         {TAP_DRPAUSE,   TAP_IRPAUSE,    8,                              {TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE,
 134                                                                                                                 TAP_DRSELECT, TAP_IRSELECT,
 135                                                                                                                 TAP_IRCAPTURE, TAP_IREXIT1, TAP_IRPAUSE} },
 136
 137 /*      {TAP_IRPAUSE,   TAP_RESET,              6,                              {TAP_IRPAUSE,
 138  * TAP_IREXIT2, TAP_IRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_RESET}}, */
 139         {TAP_IRPAUSE,   TAP_IDLE,               4,                              {TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE,
 140                                                                                                                 TAP_IDLE} },
 141         {TAP_IRPAUSE,   TAP_DRPAUSE,    7,                              {TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE,
 142                                                                                                                 TAP_DRSELECT, TAP_DRCAPTURE,
 143                                                                                                                 TAP_DREXIT1, TAP_DRPAUSE} },
 144         {TAP_IRPAUSE,   TAP_IRPAUSE,    8,                              {TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE,
 145                                                                                                                 TAP_DRSELECT, TAP_IRSELECT,
 146                                                                                                                 TAP_IRCAPTURE, TAP_IREXIT1, TAP_IRPAUSE} }
 147 };
 148
 149 #define XXR_TDI                         (1 << 0)
 150 #define XXR_TDO                         (1 << 1)
 151 #define XXR_MASK                        (1 << 2)
 152 #define XXR_SMASK                       (1 << 3)
 153 struct svf_xxr_para {
 154         int len;
 155         int data_mask;
 156         uint8_t *tdi;
 157         uint8_t *tdo;
 158         uint8_t *mask;
 159         uint8_t *smask;
 160 };
 161
 162 struct svf_para {
 163         float frequency;
 164         tap_state_t ir_end_state;
 165         tap_state_t dr_end_state;
 166         tap_state_t runtest_run_state;
 167         tap_state_t runtest_end_state;
 168         enum trst_mode trst_mode;
 169
 170         struct svf_xxr_para hir_para;
 171         struct svf_xxr_para hdr_para;
 172         struct svf_xxr_para tir_para;
 173         struct svf_xxr_para tdr_para;
 174         struct svf_xxr_para sir_para;
 175         struct svf_xxr_para sdr_para;
 176 };
 177
 178 static struct svf_para svf_para;
 179 static const struct svf_para svf_para_init = {
 180 /*      frequency, ir_end_state, dr_end_state, runtest_run_state, runtest_end_state, trst_mode */
 181         0,                      TAP_IDLE,               TAP_IDLE,       TAP_IDLE,               TAP_IDLE,               TRST_Z,
 182 /*      hir_para */
 183 /*      {len,   data_mask,      tdi,    tdo,    mask,   smask}, */
 184         {0,                     0,              NULL,   NULL,   NULL,   NULL},
 185 /*      hdr_para */
 186 /*      {len,   data_mask,      tdi,    tdo,    mask,   smask}, */
 187         {0,                     0,              NULL,   NULL,   NULL,   NULL},
 188 /*      tir_para */
 189 /*      {len,   data_mask,      tdi,    tdo,    mask,   smask}, */
 190         {0,                     0,              NULL,   NULL,   NULL,   NULL},
 191 /*      tdr_para */
 192 /*      {len,   data_mask,      tdi,    tdo,    mask,   smask}, */
 193         {0,                     0,              NULL,   NULL,   NULL,   NULL},
 194 /*      sir_para */
 195 /*      {len,   data_mask,      tdi,    tdo,    mask,   smask}, */
 196         {0,                     0,              NULL,   NULL,   NULL,   NULL},
 197 /*      sdr_para */
 198 /*      {len,   data_mask,      tdi,    tdo,    mask,   smask}, */
 199         {0,                     0,              NULL,   NULL,   NULL,   NULL},
 200 };
 201
 202 struct svf_check_tdo_para {
 203         int line_num;           /* used to record line number of the check operation */
 204         /* so more information could be printed */
 205         int enabled;            /* check is enabled or not */
 206         int buffer_offset;      /* buffer_offset to buffers */
 207         int bit_len;            /* bit length to check */
 208 };
 209
 210 #define SVF_CHECK_TDO_PARA_SIZE 1024
 211 static struct svf_check_tdo_para *svf_check_tdo_para;
 212 static int svf_check_tdo_para_index;
 213
 214 static int svf_read_command_from_file(FILE *fd);
 215 static int svf_check_tdo(void);
 216 static int svf_add_check_para(uint8_t enabled, int buffer_offset, int bit_len);
 217 static int svf_run_command(struct command_context *cmd_ctx, char *cmd_str);
 218 static int svf_execute_tap(void);
 219
 220 static FILE *svf_fd;
 221 static char *svf_read_line;
 222 static size_t svf_read_line_size;
 223 static char *svf_command_buffer;
 224 static size_t svf_command_buffer_size;
 225 static int svf_line_number;
 226 static int svf_getline(char **lineptr, size_t *n, FILE *stream);
 227
 228 #define SVF_MAX_BUFFER_SIZE_TO_COMMIT   (1024 * 1024)
 229 static uint8_t *svf_tdi_buffer, *svf_tdo_buffer, *svf_mask_buffer;
 230 static int svf_buffer_index, svf_buffer_size;
 231 static int svf_quiet;
 232 static int svf_nil;
 233 static int svf_ignore_error;
 234
 235 /* Targeting particular tap */
 236 static int svf_tap_is_specified;
 237 static int svf_set_padding(struct svf_xxr_para *para, int len, unsigned char tdi);
 238
 239 /* Progress Indicator */
 240 static int svf_progress_enabled;
 241 static long svf_total_lines;
 242 static int svf_percentage;
 243 static int svf_last_printed_percentage = -1;
 244
 245 /*
 246  * macro is used to print the svf hex buffer at desired debug level
 247  * DEBUG, INFO, ERROR, USER
 248  */
 249 #define SVF_BUF_LOG(_lvl, _buf, _nbits, _desc)                                                  \
 250         svf_hexbuf_print(LOG_LVL_##_lvl,  __FILE__, __LINE__, __func__, _buf, _nbits, _desc)
 251
 252 static void svf_hexbuf_print(int dbg_lvl, const char *file, unsigned line,
 253                                                          const char *function, const uint8_t *buf,
 254                                                          int bit_len, const char *desc)
 255 {
 256         int j, len = 0;
 257         int byte_len = DIV_ROUND_UP(bit_len, 8);
 258         int msbits = bit_len % 8;
 259
 260         /* allocate 2 bytes per hex digit */
 261         char *prbuf = malloc((byte_len * 2) + 2 + 1);
 262         if (!prbuf)
 263                 return;
 264
 265         /* print correct number of bytes, mask excess bits where applicable */
 266         uint8_t msb = buf[byte_len - 1] & (msbits ? (1 << msbits) - 1 : 0xff);
 267         len = sprintf(prbuf, msbits <= 4 ? "0x%01"PRIx8 : "0x%02"PRIx8, msb);
 268         for (j = byte_len - 2; j >= 0; j--)
 269                 len += sprintf(prbuf + len, "%02"PRIx8, buf[j]);
 270
 271         log_printf_lf(dbg_lvl, file, line, function, "%8s = %s", desc ? desc : " ", prbuf);
 272
 273         free(prbuf);
 274 }
 275
 276 static int svf_realloc_buffers(size_t len)
 277 {
 278         void *ptr;
 279
 280         if (svf_execute_tap() != ERROR_OK)
 281                 return ERROR_FAIL;
 282
 283         ptr = realloc(svf_tdi_buffer, len);
 284         if (!ptr)
 285                 return ERROR_FAIL;
 286         svf_tdi_buffer = ptr;
 287
 288         ptr = realloc(svf_tdo_buffer, len);
 289         if (!ptr)
 290                 return ERROR_FAIL;
 291         svf_tdo_buffer = ptr;
 292
 293         ptr = realloc(svf_mask_buffer, len);
 294         if (!ptr)
 295                 return ERROR_FAIL;
 296         svf_mask_buffer = ptr;
 297
 298         svf_buffer_size = len;
 299
 300         return ERROR_OK;
 301 }
 302
 303 static void svf_free_xxd_para(struct svf_xxr_para *para)
 304 {
 305         if (para) {
 306                 free(para->tdi);
 307                 para->tdi = NULL;
 308
 309                 free(para->tdo);
 310                 para->tdo = NULL;
 311
 312                 free(para->mask);
 313                 para->mask = NULL;
 314
 315                 free(para->smask);
 316                 para->smask = NULL;
 317         }
 318 }
 319
 320 int svf_add_statemove(tap_state_t state_to)
 321 {
 322         tap_state_t state_from = cmd_queue_cur_state;
 323         unsigned index_var;
 324
 325         /* when resetting, be paranoid and ignore current state */
 326         if (state_to == TAP_RESET) {
 327                 if (svf_nil)
 328                         return ERROR_OK;
 329
 330                 jtag_add_tlr();
 331                 return ERROR_OK;
 332         }
 333
 334         for (index_var = 0; index_var < ARRAY_SIZE(svf_statemoves); index_var++) {
 335                 if ((svf_statemoves[index_var].from == state_from)
 336                                 && (svf_statemoves[index_var].to == state_to)) {
 337                         if (svf_nil)
 338                                 continue;
 339                                                 /* recorded path includes current state ... avoid
 340                                                  *extra TCKs! */
 341                         if (svf_statemoves[index_var].num_of_moves > 1)
 342                                 jtag_add_pathmove(svf_statemoves[index_var].num_of_moves - 1,
 343                                         svf_statemoves[index_var].paths + 1);
 344                         else
 345                                 jtag_add_pathmove(svf_statemoves[index_var].num_of_moves,
 346                                         svf_statemoves[index_var].paths);
 347                         return ERROR_OK;
 348                 }
 349         }
 350         LOG_ERROR("SVF: can not move to %s", tap_state_name(state_to));
 351         return ERROR_FAIL;
 352 }
 353
 354 COMMAND_HANDLER(handle_svf_command)
 355 {
 356 #define SVF_MIN_NUM_OF_OPTIONS 1
 357 #define SVF_MAX_NUM_OF_OPTIONS 5
 358         int command_num = 0;
 359         int ret = ERROR_OK;
 360         int64_t time_measure_ms;
 361         int time_measure_s, time_measure_m;
 362
 363         /* use NULL to indicate a "plain" svf file which accounts for
 364          * any additional devices in the scan chain, otherwise the device
 365          * that should be affected
 366         */
 367         struct jtag_tap *tap = NULL;
 368
 369         if ((CMD_ARGC < SVF_MIN_NUM_OF_OPTIONS) || (CMD_ARGC > SVF_MAX_NUM_OF_OPTIONS))
 370                 return ERROR_COMMAND_SYNTAX_ERROR;
 371
 372         /* parse command line */
 373         svf_quiet = 0;
 374         svf_nil = 0;
 375         svf_progress_enabled = 0;
 376         svf_ignore_error = 0;
 377         for (unsigned int i = 0; i < CMD_ARGC; i++) {
 378                 if (strcmp(CMD_ARGV[i], "-tap") == 0) {
 379                         tap = jtag_tap_by_string(CMD_ARGV[i+1]);
 380                         if (!tap) {
 381                                 command_print(CMD, "Tap: %s unknown", CMD_ARGV[i+1]);
 382                                 return ERROR_FAIL;
 383                         }
 384                         i++;
 385                 } else if ((strcmp(CMD_ARGV[i],
 386                                 "quiet") == 0) || (strcmp(CMD_ARGV[i], "-quiet") == 0))
 387                         svf_quiet = 1;
 388                 else if ((strcmp(CMD_ARGV[i], "nil") == 0) || (strcmp(CMD_ARGV[i], "-nil") == 0))
 389                         svf_nil = 1;
 390                 else if ((strcmp(CMD_ARGV[i],
 391                                   "progress") == 0) || (strcmp(CMD_ARGV[i], "-progress") == 0))
 392                         svf_progress_enabled = 1;
 393                 else if ((strcmp(CMD_ARGV[i],
 394                                   "ignore_error") == 0) || (strcmp(CMD_ARGV[i], "-ignore_error") == 0))
 395                         svf_ignore_error = 1;
 396                 else {
 397                         svf_fd = fopen(CMD_ARGV[i], "r");
 398                         if (!svf_fd) {
 399                                 int err = errno;
 400                                 command_print(CMD, "open(\"%s\"): %s", CMD_ARGV[i], strerror(err));
 401                                 /* no need to free anything now */
 402                                 return ERROR_COMMAND_SYNTAX_ERROR;
 403                         } else
 404                                 LOG_USER("svf processing file: \"%s\"", CMD_ARGV[i]);
 405                 }
 406         }
 407
 408         if (!svf_fd)
 409                 return ERROR_COMMAND_SYNTAX_ERROR;
 410
 411         /* get time */
 412         time_measure_ms = timeval_ms();
 413
 414         /* init */
 415         svf_line_number = 0;
 416         svf_command_buffer_size = 0;
 417
 418         svf_check_tdo_para_index = 0;
 419         svf_check_tdo_para = malloc(sizeof(struct svf_check_tdo_para) * SVF_CHECK_TDO_PARA_SIZE);
 420         if (!svf_check_tdo_para) {
 421                 LOG_ERROR("not enough memory");
 422                 ret = ERROR_FAIL;
 423                 goto free_all;
 424         }
 425
 426         svf_buffer_index = 0;
 427         /* double the buffer size */
 428         /* in case current command cannot be committed, and next command is a bit scan command */
 429         /* here is 32K bits for this big scan command, it should be enough */
 430         /* buffer will be reallocated if buffer size is not enough */
 431         if (svf_realloc_buffers(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT) != ERROR_OK) {
 432                 ret = ERROR_FAIL;
 433                 goto free_all;
 434         }
 435
 436         memcpy(&svf_para, &svf_para_init, sizeof(svf_para));
 437
 438         if (!svf_nil) {
 439                 /* TAP_RESET */
 440                 jtag_add_tlr();
 441         }
 442
 443         if (tap) {
 444                 /* Tap is specified, set header/trailer paddings */
 445                 int header_ir_len = 0, header_dr_len = 0, trailer_ir_len = 0, trailer_dr_len = 0;
 446                 struct jtag_tap *check_tap;
 447
 448                 svf_tap_is_specified = 1;
 449
 450                 for (check_tap = jtag_all_taps(); check_tap; check_tap = check_tap->next_tap) {
 451                         if (check_tap->abs_chain_position < tap->abs_chain_position) {
 452                                 /* Header */
 453                                 header_ir_len += check_tap->ir_length;
 454                                 header_dr_len++;
 455                         } else if (check_tap->abs_chain_position > tap->abs_chain_position) {
 456                                 /* Trailer */
 457                                 trailer_ir_len += check_tap->ir_length;
 458                                 trailer_dr_len++;
 459                         }
 460                 }
 461
 462                 /* HDR %d TDI (0) */
 463                 if (ERROR_OK != svf_set_padding(&svf_para.hdr_para, header_dr_len, 0)) {
 464                         LOG_ERROR("failed to set data header");
 465                         return ERROR_FAIL;
 466                 }
 467
 468                 /* HIR %d TDI (0xFF) */
 469                 if (ERROR_OK != svf_set_padding(&svf_para.hir_para, header_ir_len, 0xFF)) {
 470                         LOG_ERROR("failed to set instruction header");
 471                         return ERROR_FAIL;
 472                 }
 473
 474                 /* TDR %d TDI (0) */
 475                 if (ERROR_OK != svf_set_padding(&svf_para.tdr_para, trailer_dr_len, 0)) {
 476                         LOG_ERROR("failed to set data trailer");
 477                         return ERROR_FAIL;
 478                 }
 479
 480                 /* TIR %d TDI (0xFF) */
 481                 if (ERROR_OK != svf_set_padding(&svf_para.tir_para, trailer_ir_len, 0xFF)) {
 482                         LOG_ERROR("failed to set instruction trailer");
 483                         return ERROR_FAIL;
 484                 }
 485         }
 486
 487         if (svf_progress_enabled) {
 488                 /* Count total lines in file. */
 489                 while (!feof(svf_fd)) {
 490                         svf_getline(&svf_command_buffer, &svf_command_buffer_size, svf_fd);
 491                         svf_total_lines++;
 492                 }
 493                 rewind(svf_fd);
 494         }
 495         while (ERROR_OK == svf_read_command_from_file(svf_fd)) {
 496                 /* Log Output */
 497                 if (svf_quiet) {
 498                         if (svf_progress_enabled) {
 499                                 svf_percentage = ((svf_line_number * 20) / svf_total_lines) * 5;
 500                                 if (svf_last_printed_percentage != svf_percentage) {
 501                                         LOG_USER_N("\r%d%%    ", svf_percentage);
 502                                         svf_last_printed_percentage = svf_percentage;
 503                                 }
 504                         }
 505                 } else {
 506                         if (svf_progress_enabled) {
 507                                 svf_percentage = ((svf_line_number * 20) / svf_total_lines) * 5;
 508                                 LOG_USER_N("%3d%%  %s", svf_percentage, svf_read_line);
 509                         } else
 510                                 LOG_USER_N("%s", svf_read_line);
 511                 }
 512                 /* Run Command */
 513                 if (ERROR_OK != svf_run_command(CMD_CTX, svf_command_buffer)) {
 514                         LOG_ERROR("fail to run command at line %d", svf_line_number);
 515                         ret = ERROR_FAIL;
 516                         break;
 517                 }
 518                 command_num++;
 519         }
 520
 521         if ((!svf_nil) && (ERROR_OK != jtag_execute_queue()))
 522                 ret = ERROR_FAIL;
 523         else if (ERROR_OK != svf_check_tdo())
 524                 ret = ERROR_FAIL;
 525
 526         /* print time */
 527         time_measure_ms = timeval_ms() - time_measure_ms;
 528         time_measure_s = time_measure_ms / 1000;
 529         time_measure_ms %= 1000;
 530         time_measure_m = time_measure_s / 60;
 531         time_measure_s %= 60;
 532         if (time_measure_ms < 1000)
 533                 command_print(CMD,
 534                         "\r\nTime used: %dm%ds%" PRId64 "ms ",
 535                         time_measure_m,
 536                         time_measure_s,
 537                         time_measure_ms);
 538
 539 free_all:
 540
 541         fclose(svf_fd);
 542         svf_fd = 0;
 543
 544         /* free buffers */
 545         free(svf_command_buffer);
 546         svf_command_buffer = NULL;
 547         svf_command_buffer_size = 0;
 548
 549         free(svf_check_tdo_para);
 550         svf_check_tdo_para = NULL;
 551         svf_check_tdo_para_index = 0;
 552
 553         free(svf_tdi_buffer);
 554         svf_tdi_buffer = NULL;
 555
 556         free(svf_tdo_buffer);
 557         svf_tdo_buffer = NULL;
 558
 559         free(svf_mask_buffer);
 560         svf_mask_buffer = NULL;
 561
 562         svf_buffer_index = 0;
 563         svf_buffer_size = 0;
 564
 565         svf_free_xxd_para(&svf_para.hdr_para);
 566         svf_free_xxd_para(&svf_para.hir_para);
 567         svf_free_xxd_para(&svf_para.tdr_para);
 568         svf_free_xxd_para(&svf_para.tir_para);
 569         svf_free_xxd_para(&svf_para.sdr_para);
 570         svf_free_xxd_para(&svf_para.sir_para);
 571
 572         if (ret == ERROR_OK)
 573                 command_print(CMD,
 574                               "svf file programmed %s for %d commands with %d errors",
 575                               (svf_ignore_error > 1) ? "unsuccessfully" : "successfully",
 576                               command_num,
 577                               (svf_ignore_error > 1) ? (svf_ignore_error - 1) : 0);
 578         else
 579                 command_print(CMD, "svf file programmed failed");
 580
 581         svf_ignore_error = 0;
 582         return ret;
 583 }
 584
 585 static int svf_getline(char **lineptr, size_t *n, FILE *stream)
 586 {
 587 #define MIN_CHUNK 16    /* Buffer is increased by this size each time as required */
 588         size_t i = 0;
 589
 590         if (*lineptr == NULL) {
 591                 *n = MIN_CHUNK;
 592                 *lineptr = malloc(*n);
 593                 if (!*lineptr)
 594                         return -1;
 595         }
 596
 597         (*lineptr)[0] = fgetc(stream);
 598         while ((*lineptr)[i] != '\n') {
 599                 (*lineptr)[++i] = fgetc(stream);
 600                 if (feof(stream)) {
 601                         (*lineptr)[0] = 0;
 602                         return -1;
 603                 }
 604                 if ((i + 2) > *n) {
 605                         *n += MIN_CHUNK;
 606                         *lineptr = realloc(*lineptr, *n);
 607                 }
 608         }
 609
 610         (*lineptr)[++i] = 0;
 611
 612         return sizeof(*lineptr);
 613 }
 614
 615 #define SVFP_CMD_INC_CNT 1024
 616 static int svf_read_command_from_file(FILE *fd)
 617 {
 618         unsigned char ch;
 619         int i = 0;
 620         size_t cmd_pos = 0;
 621         int cmd_ok = 0, slash = 0;
 622
 623         if (svf_getline(&svf_read_line, &svf_read_line_size, svf_fd) <= 0)
 624                 return ERROR_FAIL;
 625         svf_line_number++;
 626         ch = svf_read_line[0];
 627         while (!cmd_ok && (ch != 0)) {
 628                 switch (ch) {
 629                         case '!':
 630                                 slash = 0;
 631                                 if (svf_getline(&svf_read_line, &svf_read_line_size, svf_fd) <= 0)
 632                                         return ERROR_FAIL;
 633                                 svf_line_number++;
 634                                 i = -1;
 635                                 break;
 636                         case '/':
 637                                 if (++slash == 2) {
 638                                         slash = 0;
 639                                         if (svf_getline(&svf_read_line, &svf_read_line_size,
 640                                                 svf_fd) <= 0)
 641                                                 return ERROR_FAIL;
 642                                         svf_line_number++;
 643                                         i = -1;
 644                                 }
 645                                 break;
 646                         case ';':
 647                                 slash = 0;
 648                                 cmd_ok = 1;
 649                                 break;
 650                         case '\n':
 651                                 svf_line_number++;
 652                                 if (svf_getline(&svf_read_line, &svf_read_line_size, svf_fd) <= 0)
 653                                         return ERROR_FAIL;
 654                                 i = -1;
 655                                 /* fallthrough */
 656                         case '\r':
 657                                 slash = 0;
 658                                 /* Don't save '\r' and '\n' if no data is parsed */
 659                                 if (!cmd_pos)
 660                                         break;
 661                                 /* fallthrough */
 662                         default:
 663                                 /* The parsing code currently expects a space
 664                                  * before parentheses -- "TDI (123)".  Also a
 665                                  * space afterwards -- "TDI (123) TDO(456)".
 666                                  * But such spaces are optional... instead of
 667                                  * parser updates, cope with that by adding the
 668                                  * spaces as needed.
 669                                  *
 670                                  * Ensure there are 3 bytes available, for:
 671                                  *  - current character
 672                                  *  - added space.
 673                                  *  - terminating NUL ('\0')
 674                                  */
 675                                 if (cmd_pos + 3 > svf_command_buffer_size) {
 676                                         svf_command_buffer = realloc(svf_command_buffer, cmd_pos + 3);
 677                                         svf_command_buffer_size = cmd_pos + 3;
 678                                         if (!svf_command_buffer) {
 679                                                 LOG_ERROR("not enough memory");
 680                                                 return ERROR_FAIL;
 681                                         }
 682                                 }
 683
 684                                 /* insert a space before '(' */
 685                                 if ('(' == ch)
 686                                         svf_command_buffer[cmd_pos++] = ' ';
 687
 688                                 svf_command_buffer[cmd_pos++] = (char)toupper(ch);
 689
 690                                 /* insert a space after ')' */
 691                                 if (')' == ch)
 692                                         svf_command_buffer[cmd_pos++] = ' ';
 693                                 break;
 694                 }
 695                 ch = svf_read_line[++i];
 696         }
 697
 698         if (cmd_ok) {
 699                 svf_command_buffer[cmd_pos] = '\0';
 700                 return ERROR_OK;
 701         } else
 702                 return ERROR_FAIL;
 703 }
 704
 705 static int svf_parse_cmd_string(char *str, int len, char **argus, int *num_of_argu)
 706 {
 707         int pos = 0, num = 0, space_found = 1, in_bracket = 0;
 708
 709         while (pos < len) {
 710                 switch (str[pos]) {
 711                         case '!':
 712                         case '/':
 713                                 LOG_ERROR("fail to parse svf command");
 714                                 return ERROR_FAIL;
 715                         case '(':
 716                                 in_bracket = 1;
 717                                 goto parse_char;
 718                         case ')':
 719                                 in_bracket = 0;
 720                                 goto parse_char;
 721                         default:
 722 parse_char:
 723                                 if (!in_bracket && isspace((int) str[pos])) {
 724                                         space_found = 1;
 725                                         str[pos] = '\0';
 726                                 } else if (space_found) {
 727                                         argus[num++] = &str[pos];
 728                                         space_found = 0;
 729                                 }
 730                                 break;
 731                 }
 732                 pos++;
 733         }
 734
 735         if (num == 0)
 736                 return ERROR_FAIL;
 737
 738         *num_of_argu = num;
 739
 740         return ERROR_OK;
 741 }
 742
 743 bool svf_tap_state_is_stable(tap_state_t state)
 744 {
 745         return (state == TAP_RESET) || (state == TAP_IDLE)
 746                         || (state == TAP_DRPAUSE) || (state == TAP_IRPAUSE);
 747 }
 748
 749 static int svf_find_string_in_array(char *str, char **strs, int num_of_element)
 750 {
 751         int i;
 752
 753         for (i = 0; i < num_of_element; i++) {
 754                 if (!strcmp(str, strs[i]))
 755                         return i;
 756         }
 757         return 0xFF;
 758 }
 759
 760 static int svf_adjust_array_length(uint8_t **arr, int orig_bit_len, int new_bit_len)
 761 {
 762         int new_byte_len = (new_bit_len + 7) >> 3;
 763
 764         if ((NULL == *arr) || (((orig_bit_len + 7) >> 3) < ((new_bit_len + 7) >> 3))) {
 765                 free(*arr);
 766                 *arr = calloc(1, new_byte_len);
 767                 if (NULL == *arr) {
 768                         LOG_ERROR("not enough memory");
 769                         return ERROR_FAIL;
 770                 }
 771         }
 772         return ERROR_OK;
 773 }
 774
 775 static int svf_set_padding(struct svf_xxr_para *para, int len, unsigned char tdi)
 776 {
 777         int error = ERROR_OK;
 778         error |= svf_adjust_array_length(&para->tdi, para->len, len);
 779         memset(para->tdi, tdi, (len + 7) >> 3);
 780         error |= svf_adjust_array_length(&para->tdo, para->len, len);
 781         error |= svf_adjust_array_length(&para->mask, para->len, len);
 782         para->len = len;
 783         para->data_mask = XXR_TDI;
 784
 785         return error;
 786 }
 787
 788 static int svf_copy_hexstring_to_binary(char *str, uint8_t **bin, int orig_bit_len, int bit_len)
 789 {
 790         int i, str_len = strlen(str), str_hbyte_len = (bit_len + 3) >> 2;
 791         uint8_t ch = 0;
 792
 793         if (ERROR_OK != svf_adjust_array_length(bin, orig_bit_len, bit_len)) {
 794                 LOG_ERROR("fail to adjust length of array");
 795                 return ERROR_FAIL;
 796         }
 797
 798         /* fill from LSB (end of str) to MSB (beginning of str) */
 799         for (i = 0; i < str_hbyte_len; i++) {
 800                 ch = 0;
 801                 while (str_len > 0) {
 802                         ch = str[--str_len];
 803
 804                         /* Skip whitespace.  The SVF specification (rev E) is
 805                          * deficient in terms of basic lexical issues like
 806                          * where whitespace is allowed.  Long bitstrings may
 807                          * require line ends for correctness, since there is
 808                          * a hard limit on line length.
 809                          */
 810                         if (!isspace(ch)) {
 811                                 if ((ch >= '0') && (ch <= '9')) {
 812                                         ch = ch - '0';
 813                                         break;
 814                                 } else if ((ch >= 'A') && (ch <= 'F')) {
 815                                         ch = ch - 'A' + 10;
 816                                         break;
 817                                 } else {
 818                                         LOG_ERROR("invalid hex string");
 819                                         return ERROR_FAIL;
 820                                 }
 821                         }
 822
 823                         ch = 0;
 824                 }
 825
 826                 /* write bin */
 827                 if (i % 2) {
 828                         /* MSB */
 829                         (*bin)[i / 2] |= ch << 4;
 830                 } else {
 831                         /* LSB */
 832                         (*bin)[i / 2] = 0;
 833                         (*bin)[i / 2] |= ch;
 834                 }
 835         }
 836
 837         /* consume optional leading '0' MSBs or whitespace */
 838         while (str_len > 0 && ((str[str_len - 1] == '0')
 839                         || isspace((int) str[str_len - 1])))
 840                 str_len--;
 841
 842         /* check validity: we must have consumed everything */
 843         if (str_len > 0 || (ch & ~((2 << ((bit_len - 1) % 4)) - 1)) != 0) {
 844                 LOG_ERROR("value exceeds length");
 845                 return ERROR_FAIL;
 846         }
 847
 848         return ERROR_OK;
 849 }
 850
 851 static int svf_check_tdo(void)
 852 {
 853         int i, len, index_var;
 854
 855         for (i = 0; i < svf_check_tdo_para_index; i++) {
 856                 index_var = svf_check_tdo_para[i].buffer_offset;
 857                 len = svf_check_tdo_para[i].bit_len;
 858                 if ((svf_check_tdo_para[i].enabled)
 859                                 && buf_cmp_mask(&svf_tdi_buffer[index_var], &svf_tdo_buffer[index_var],
 860                                 &svf_mask_buffer[index_var], len)) {
 861                         LOG_ERROR("tdo check error at line %d",
 862                                 svf_check_tdo_para[i].line_num);
 863                         SVF_BUF_LOG(ERROR, &svf_tdi_buffer[index_var], len, "READ");
 864                         SVF_BUF_LOG(ERROR, &svf_tdo_buffer[index_var], len, "WANT");
 865                         SVF_BUF_LOG(ERROR, &svf_mask_buffer[index_var], len, "MASK");
 866
 867                         if (svf_ignore_error == 0)
 868                                 return ERROR_FAIL;
 869                         else
 870                                 svf_ignore_error++;
 871                 }
 872         }
 873         svf_check_tdo_para_index = 0;
 874
 875         return ERROR_OK;
 876 }
 877
 878 static int svf_add_check_para(uint8_t enabled, int buffer_offset, int bit_len)
 879 {
 880         if (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE) {
 881                 LOG_ERROR("toooooo many operation undone");
 882                 return ERROR_FAIL;
 883         }
 884
 885         svf_check_tdo_para[svf_check_tdo_para_index].line_num = svf_line_number;
 886         svf_check_tdo_para[svf_check_tdo_para_index].bit_len = bit_len;
 887         svf_check_tdo_para[svf_check_tdo_para_index].enabled = enabled;
 888         svf_check_tdo_para[svf_check_tdo_para_index].buffer_offset = buffer_offset;
 889         svf_check_tdo_para_index++;
 890
 891         return ERROR_OK;
 892 }
 893
 894 static int svf_execute_tap(void)
 895 {
 896         if ((!svf_nil) && (ERROR_OK != jtag_execute_queue()))
 897                 return ERROR_FAIL;
 898         else if (ERROR_OK != svf_check_tdo())
 899                 return ERROR_FAIL;
 900
 901         svf_buffer_index = 0;
 902
 903         return ERROR_OK;
 904 }
 905
 906 static int svf_run_command(struct command_context *cmd_ctx, char *cmd_str)
 907 {
 908         char *argus[256], command;
 909         int num_of_argu = 0, i;
 910
 911         /* tmp variable */
 912         int i_tmp;
 913
 914         /* for RUNTEST */
 915         int run_count;
 916         float min_time;
 917         /* for XXR */
 918         struct svf_xxr_para *xxr_para_tmp;
 919         uint8_t **pbuffer_tmp;
 920         struct scan_field field;
 921         /* for STATE */
 922         tap_state_t *path = NULL, state;
 923         /* flag padding commands skipped due to -tap command */
 924         int padding_command_skipped = 0;
 925
 926         if (ERROR_OK != svf_parse_cmd_string(cmd_str, strlen(cmd_str), argus, &num_of_argu))
 927                 return ERROR_FAIL;
 928
 929         /* NOTE: we're a bit loose here, because we ignore case in
 930          * TAP state names (instead of insisting on uppercase).
 931          */
 932
 933         command = svf_find_string_in_array(argus[0],
 934                         (char **)svf_command_name, ARRAY_SIZE(svf_command_name));
 935         switch (command) {
 936                 case ENDDR:
 937                 case ENDIR:
 938                         if (num_of_argu != 2) {
 939                                 LOG_ERROR("invalid parameter of %s", argus[0]);
 940                                 return ERROR_FAIL;
 941                         }
 942
 943                         i_tmp = tap_state_by_name(argus[1]);
 944
 945                         if (svf_tap_state_is_stable(i_tmp)) {
 946                                 if (command == ENDIR) {
 947                                         svf_para.ir_end_state = i_tmp;
 948                                         LOG_DEBUG("\tIR end_state = %s",
 949                                                         tap_state_name(i_tmp));
 950                                 } else {
 951                                         svf_para.dr_end_state = i_tmp;
 952                                         LOG_DEBUG("\tDR end_state = %s",
 953                                                         tap_state_name(i_tmp));
 954                                 }
 955                         } else {
 956                                 LOG_ERROR("%s: %s is not a stable state",
 957                                                 argus[0], argus[1]);
 958                                 return ERROR_FAIL;
 959                         }
 960                         break;
 961                 case FREQUENCY:
 962                         if ((num_of_argu != 1) && (num_of_argu != 3)) {
 963                                 LOG_ERROR("invalid parameter of %s", argus[0]);
 964                                 return ERROR_FAIL;
 965                         }
 966                         if (1 == num_of_argu) {
 967                                 /* TODO: set jtag speed to full speed */
 968                                 svf_para.frequency = 0;
 969                         } else {
 970                                 if (strcmp(argus[2], "HZ")) {
 971                                         LOG_ERROR("HZ not found in FREQUENCY command");
 972                                         return ERROR_FAIL;
 973                                 }
 974                                 if (ERROR_OK != svf_execute_tap())
 975                                         return ERROR_FAIL;
 976                                 svf_para.frequency = atof(argus[1]);
 977                                 /* TODO: set jtag speed to */
 978                                 if (svf_para.frequency > 0) {
 979                                         command_run_linef(cmd_ctx,
 980                                                         "adapter speed %d",
 981                                                         (int)svf_para.frequency / 1000);
 982                                         LOG_DEBUG("\tfrequency = %f", svf_para.frequency);
 983                                 }
 984                         }
 985                         break;
 986                 case HDR:
 987                         if (svf_tap_is_specified) {
 988                                 padding_command_skipped = 1;
 989                                 break;
 990                         }
 991                         xxr_para_tmp = &svf_para.hdr_para;
 992                         goto xxr_common;
 993                 case HIR:
 994                         if (svf_tap_is_specified) {
 995                                 padding_command_skipped = 1;
 996                                 break;
 997                         }
 998                         xxr_para_tmp = &svf_para.hir_para;
 999                         goto xxr_common;
1000                 case TDR:
1001                         if (svf_tap_is_specified) {
1002                                 padding_command_skipped = 1;
1003                                 break;
1004                         }
1005                         xxr_para_tmp = &svf_para.tdr_para;
1006                         goto xxr_common;
1007                 case TIR:
1008                         if (svf_tap_is_specified) {
1009                                 padding_command_skipped = 1;
1010                                 break;
1011                         }
1012                         xxr_para_tmp = &svf_para.tir_para;
1013                         goto xxr_common;
1014                 case SDR:
1015                         xxr_para_tmp = &svf_para.sdr_para;
1016                         goto xxr_common;
1017                 case SIR:
1018                         xxr_para_tmp = &svf_para.sir_para;
1019                         goto xxr_common;
1020 xxr_common:
1021                         /* XXR length [TDI (tdi)] [TDO (tdo)][MASK (mask)] [SMASK (smask)] */
1022                         if ((num_of_argu > 10) || (num_of_argu % 2)) {
1023                                 LOG_ERROR("invalid parameter of %s", argus[0]);
1024                                 return ERROR_FAIL;
1025                         }
1026                         i_tmp = xxr_para_tmp->len;
1027                         xxr_para_tmp->len = atoi(argus[1]);
1028                         /* If we are to enlarge the buffers, all parts of xxr_para_tmp
1029                          * need to be freed */
1030                         if (i_tmp < xxr_para_tmp->len) {
1031                                 free(xxr_para_tmp->tdi);
1032                                 xxr_para_tmp->tdi = NULL;
1033                                 free(xxr_para_tmp->tdo);
1034                                 xxr_para_tmp->tdo = NULL;
1035                                 free(xxr_para_tmp->mask);
1036                                 xxr_para_tmp->mask = NULL;
1037                                 free(xxr_para_tmp->smask);
1038                                 xxr_para_tmp->smask = NULL;
1039                         }
1040
1041                         LOG_DEBUG("\tlength = %d", xxr_para_tmp->len);
1042                         xxr_para_tmp->data_mask = 0;
1043                         for (i = 2; i < num_of_argu; i += 2) {
1044                                 if ((strlen(argus[i + 1]) < 3) || (argus[i + 1][0] != '(') ||
1045                                 (argus[i + 1][strlen(argus[i + 1]) - 1] != ')')) {
1046                                         LOG_ERROR("data section error");
1047                                         return ERROR_FAIL;
1048                                 }
1049                                 argus[i + 1][strlen(argus[i + 1]) - 1] = '\0';
1050                                 /* TDI, TDO, MASK, SMASK */
1051                                 if (!strcmp(argus[i], "TDI")) {
1052                                         /* TDI */
1053                                         pbuffer_tmp = &xxr_para_tmp->tdi;
1054                                         xxr_para_tmp->data_mask |= XXR_TDI;
1055                                 } else if (!strcmp(argus[i], "TDO")) {
1056                                         /* TDO */
1057                                         pbuffer_tmp = &xxr_para_tmp->tdo;
1058                                         xxr_para_tmp->data_mask |= XXR_TDO;
1059                                 } else if (!strcmp(argus[i], "MASK")) {
1060                                         /* MASK */
1061                                         pbuffer_tmp = &xxr_para_tmp->mask;
1062                                         xxr_para_tmp->data_mask |= XXR_MASK;
1063                                 } else if (!strcmp(argus[i], "SMASK")) {
1064                                         /* SMASK */
1065                                         pbuffer_tmp = &xxr_para_tmp->smask;
1066                                         xxr_para_tmp->data_mask |= XXR_SMASK;
1067                                 } else {
1068                                         LOG_ERROR("unknown parameter: %s", argus[i]);
1069                                         return ERROR_FAIL;
1070                                 }
1071                                 if (ERROR_OK !=
1072                                 svf_copy_hexstring_to_binary(&argus[i + 1][1], pbuffer_tmp, i_tmp,
1073                                         xxr_para_tmp->len)) {
1074                                         LOG_ERROR("fail to parse hex value");
1075                                         return ERROR_FAIL;
1076                                 }
1077                                 SVF_BUF_LOG(DEBUG, *pbuffer_tmp, xxr_para_tmp->len, argus[i]);
1078                         }
1079                         /* If a command changes the length of the last scan of the same type and the
1080                          * MASK parameter is absent, */
1081                         /* the mask pattern used is all cares */
1082                         if (!(xxr_para_tmp->data_mask & XXR_MASK) && (i_tmp != xxr_para_tmp->len)) {
1083                                 /* MASK not defined and length changed */
1084                                 if (ERROR_OK !=
1085                                 svf_adjust_array_length(&xxr_para_tmp->mask, i_tmp,
1086                                         xxr_para_tmp->len)) {
1087                                         LOG_ERROR("fail to adjust length of array");
1088                                         return ERROR_FAIL;
1089                                 }
1090                                 buf_set_ones(xxr_para_tmp->mask, xxr_para_tmp->len);
1091                         }
1092                         /* If TDO is absent, no comparison is needed, set the mask to 0 */
1093                         if (!(xxr_para_tmp->data_mask & XXR_TDO)) {
1094                                 if (!xxr_para_tmp->tdo) {
1095                                         if (ERROR_OK !=
1096                                         svf_adjust_array_length(&xxr_para_tmp->tdo, i_tmp,
1097                                                 xxr_para_tmp->len)) {
1098                                                 LOG_ERROR("fail to adjust length of array");
1099                                                 return ERROR_FAIL;
1100                                         }
1101                                 }
1102                                 if (!xxr_para_tmp->mask) {
1103                                         if (ERROR_OK !=
1104                                         svf_adjust_array_length(&xxr_para_tmp->mask, i_tmp,
1105                                                 xxr_para_tmp->len)) {
1106                                                 LOG_ERROR("fail to adjust length of array");
1107                                                 return ERROR_FAIL;
1108                                         }
1109                                 }
1110                                 memset(xxr_para_tmp->mask, 0, (xxr_para_tmp->len + 7) >> 3);
1111                         }
1112                         /* do scan if necessary */
1113                         if (command == SDR) {
1114                                 /* check buffer size first, reallocate if necessary */
1115                                 i = svf_para.hdr_para.len + svf_para.sdr_para.len +
1116                                                 svf_para.tdr_para.len;
1117                                 if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3)) {
1118                                         /* reallocate buffer */
1119                                         if (svf_realloc_buffers(svf_buffer_index + ((i + 7) >> 3)) != ERROR_OK) {
1120                                                 LOG_ERROR("not enough memory");
1121                                                 return ERROR_FAIL;
1122                                         }
1123                                 }
1124
1125                                 /* assemble dr data */
1126                                 i = 0;
1127                                 buf_set_buf(svf_para.hdr_para.tdi,
1128                                                 0,
1129                                                 &svf_tdi_buffer[svf_buffer_index],
1130                                                 i,
1131                                                 svf_para.hdr_para.len);
1132                                 i += svf_para.hdr_para.len;
1133                                 buf_set_buf(svf_para.sdr_para.tdi,
1134                                                 0,
1135                                                 &svf_tdi_buffer[svf_buffer_index],
1136                                                 i,
1137                                                 svf_para.sdr_para.len);
1138                                 i += svf_para.sdr_para.len;
1139                                 buf_set_buf(svf_para.tdr_para.tdi,
1140                                                 0,
1141                                                 &svf_tdi_buffer[svf_buffer_index],
1142                                                 i,
1143                                                 svf_para.tdr_para.len);
1144                                 i += svf_para.tdr_para.len;
1145
1146                                 /* add check data */
1147                                 if (svf_para.sdr_para.data_mask & XXR_TDO) {
1148                                         /* assemble dr mask data */
1149                                         i = 0;
1150                                         buf_set_buf(svf_para.hdr_para.mask,
1151                                                         0,
1152                                                         &svf_mask_buffer[svf_buffer_index],
1153                                                         i,
1154                                                         svf_para.hdr_para.len);
1155                                         i += svf_para.hdr_para.len;
1156                                         buf_set_buf(svf_para.sdr_para.mask,
1157                                                         0,
1158                                                         &svf_mask_buffer[svf_buffer_index],
1159                                                         i,
1160                                                         svf_para.sdr_para.len);
1161                                         i += svf_para.sdr_para.len;
1162                                         buf_set_buf(svf_para.tdr_para.mask,
1163                                                         0,
1164                                                         &svf_mask_buffer[svf_buffer_index],
1165                                                         i,
1166                                                         svf_para.tdr_para.len);
1167
1168                                         /* assemble dr check data */
1169                                         i = 0;
1170                                         buf_set_buf(svf_para.hdr_para.tdo,
1171                                                         0,
1172                                                         &svf_tdo_buffer[svf_buffer_index],
1173                                                         i,
1174                                                         svf_para.hdr_para.len);
1175                                         i += svf_para.hdr_para.len;
1176                                         buf_set_buf(svf_para.sdr_para.tdo,
1177                                                         0,
1178                                                         &svf_tdo_buffer[svf_buffer_index],
1179                                                         i,
1180                                                         svf_para.sdr_para.len);
1181                                         i += svf_para.sdr_para.len;
1182                                         buf_set_buf(svf_para.tdr_para.tdo,
1183                                                         0,
1184                                                         &svf_tdo_buffer[svf_buffer_index],
1185                                                         i,
1186                                                         svf_para.tdr_para.len);
1187                                         i += svf_para.tdr_para.len;
1188
1189                                         svf_add_check_para(1, svf_buffer_index, i);
1190                                 } else
1191                                         svf_add_check_para(0, svf_buffer_index, i);
1192                                 field.num_bits = i;
1193                                 field.out_value = &svf_tdi_buffer[svf_buffer_index];
1194                                 field.in_value = (xxr_para_tmp->data_mask & XXR_TDO) ? &svf_tdi_buffer[svf_buffer_index] : NULL;
1195                                 if (!svf_nil) {
1196                                         /* NOTE:  doesn't use SVF-specified state paths */
1197                                         jtag_add_plain_dr_scan(field.num_bits,
1198                                                         field.out_value,
1199                                                         field.in_value,
1200                                                         svf_para.dr_end_state);
1201                                 }
1202
1203                                 svf_buffer_index += (i + 7) >> 3;
1204                         } else if (command == SIR) {
1205                                 /* check buffer size first, reallocate if necessary */
1206                                 i = svf_para.hir_para.len + svf_para.sir_para.len +
1207                                                 svf_para.tir_para.len;
1208                                 if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3)) {
1209                                         if (svf_realloc_buffers(svf_buffer_index + ((i + 7) >> 3)) != ERROR_OK) {
1210                                                 LOG_ERROR("not enough memory");
1211                                                 return ERROR_FAIL;
1212                                         }
1213                                 }
1214
1215                                 /* assemble ir data */
1216                                 i = 0;
1217                                 buf_set_buf(svf_para.hir_para.tdi,
1218                                                 0,
1219                                                 &svf_tdi_buffer[svf_buffer_index],
1220                                                 i,
1221                                                 svf_para.hir_para.len);
1222                                 i += svf_para.hir_para.len;
1223                                 buf_set_buf(svf_para.sir_para.tdi,
1224                                                 0,
1225                                                 &svf_tdi_buffer[svf_buffer_index],
1226                                                 i,
1227                                                 svf_para.sir_para.len);
1228                                 i += svf_para.sir_para.len;
1229                                 buf_set_buf(svf_para.tir_para.tdi,
1230                                                 0,
1231                                                 &svf_tdi_buffer[svf_buffer_index],
1232                                                 i,
1233                                                 svf_para.tir_para.len);
1234                                 i += svf_para.tir_para.len;
1235
1236                                 /* add check data */
1237                                 if (svf_para.sir_para.data_mask & XXR_TDO) {
1238                                         /* assemble dr mask data */
1239                                         i = 0;
1240                                         buf_set_buf(svf_para.hir_para.mask,
1241                                                         0,
1242                                                         &svf_mask_buffer[svf_buffer_index],
1243                                                         i,
1244                                                         svf_para.hir_para.len);
1245                                         i += svf_para.hir_para.len;
1246                                         buf_set_buf(svf_para.sir_para.mask,
1247                                                         0,
1248                                                         &svf_mask_buffer[svf_buffer_index],
1249                                                         i,
1250                                                         svf_para.sir_para.len);
1251                                         i += svf_para.sir_para.len;
1252                                         buf_set_buf(svf_para.tir_para.mask,
1253                                                         0,
1254                                                         &svf_mask_buffer[svf_buffer_index],
1255                                                         i,
1256                                                         svf_para.tir_para.len);
1257
1258                                         /* assemble dr check data */
1259                                         i = 0;
1260                                         buf_set_buf(svf_para.hir_para.tdo,
1261                                                         0,
1262                                                         &svf_tdo_buffer[svf_buffer_index],
1263                                                         i,
1264                                                         svf_para.hir_para.len);
1265                                         i += svf_para.hir_para.len;
1266                                         buf_set_buf(svf_para.sir_para.tdo,
1267                                                         0,
1268                                                         &svf_tdo_buffer[svf_buffer_index],
1269                                                         i,
1270                                                         svf_para.sir_para.len);
1271                                         i += svf_para.sir_para.len;
1272                                         buf_set_buf(svf_para.tir_para.tdo,
1273                                                         0,
1274                                                         &svf_tdo_buffer[svf_buffer_index],
1275                                                         i,
1276                                                         svf_para.tir_para.len);
1277                                         i += svf_para.tir_para.len;
1278
1279                                         svf_add_check_para(1, svf_buffer_index, i);
1280                                 } else
1281                                         svf_add_check_para(0, svf_buffer_index, i);
1282                                 field.num_bits = i;
1283                                 field.out_value = &svf_tdi_buffer[svf_buffer_index];
1284                                 field.in_value = (xxr_para_tmp->data_mask & XXR_TDO) ? &svf_tdi_buffer[svf_buffer_index] : NULL;
1285                                 if (!svf_nil) {
1286                                         /* NOTE:  doesn't use SVF-specified state paths */
1287                                         jtag_add_plain_ir_scan(field.num_bits,
1288                                                         field.out_value,
1289                                                         field.in_value,
1290                                                         svf_para.ir_end_state);
1291                                 }
1292
1293                                 svf_buffer_index += (i + 7) >> 3;
1294                         }
1295                         break;
1296                 case PIO:
1297                 case PIOMAP:
1298                         LOG_ERROR("PIO and PIOMAP are not supported");
1299                         return ERROR_FAIL;
1300                 case RUNTEST:
1301                         /* RUNTEST [run_state] run_count run_clk [min_time SEC [MAXIMUM max_time
1302                          * SEC]] [ENDSTATE end_state] */
1303                         /* RUNTEST [run_state] min_time SEC [MAXIMUM max_time SEC] [ENDSTATE
1304                          * end_state] */
1305                         if ((num_of_argu < 3) || (num_of_argu > 11)) {
1306                                 LOG_ERROR("invalid parameter of %s", argus[0]);
1307                                 return ERROR_FAIL;
1308                         }
1309                         /* init */
1310                         run_count = 0;
1311                         min_time = 0;
1312                         i = 1;
1313
1314                         /* run_state */
1315                         i_tmp = tap_state_by_name(argus[i]);
1316                         if (i_tmp != TAP_INVALID) {
1317                                 if (svf_tap_state_is_stable(i_tmp)) {
1318                                         svf_para.runtest_run_state = i_tmp;
1319
1320                                         /* When a run_state is specified, the new
1321                                          * run_state becomes the default end_state.
1322                                          */
1323                                         svf_para.runtest_end_state = i_tmp;
1324                                         LOG_DEBUG("\trun_state = %s", tap_state_name(i_tmp));
1325                                         i++;
1326                                 } else {
1327                                         LOG_ERROR("%s: %s is not a stable state", argus[0], tap_state_name(i_tmp));
1328                                         return ERROR_FAIL;
1329                                 }
1330                         }
1331
1332                         /* run_count run_clk */
1333                         if (((i + 2) <= num_of_argu) && strcmp(argus[i + 1], "SEC")) {
1334                                 if (!strcmp(argus[i + 1], "TCK")) {
1335                                         /* clock source is TCK */
1336                                         run_count = atoi(argus[i]);
1337                                         LOG_DEBUG("\trun_count@TCK = %d", run_count);
1338                                 } else {
1339                                         LOG_ERROR("%s not supported for clock", argus[i + 1]);
1340                                         return ERROR_FAIL;
1341                                 }
1342                                 i += 2;
1343                         }
1344                         /* min_time SEC */
1345                         if (((i + 2) <= num_of_argu) && !strcmp(argus[i + 1], "SEC")) {
1346                                 min_time = atof(argus[i]);
1347                                 LOG_DEBUG("\tmin_time = %fs", min_time);
1348                                 i += 2;
1349                         }
1350                         /* MAXIMUM max_time SEC */
1351                         if (((i + 3) <= num_of_argu) &&
1352                         !strcmp(argus[i], "MAXIMUM") && !strcmp(argus[i + 2], "SEC")) {
1353                                 float max_time = 0;
1354                                 max_time = atof(argus[i + 1]);
1355                                 LOG_DEBUG("\tmax_time = %fs", max_time);
1356                                 i += 3;
1357                         }
1358                         /* ENDSTATE end_state */
1359                         if (((i + 2) <= num_of_argu) && !strcmp(argus[i], "ENDSTATE")) {
1360                                 i_tmp = tap_state_by_name(argus[i + 1]);
1361
1362                                 if (svf_tap_state_is_stable(i_tmp)) {
1363                                         svf_para.runtest_end_state = i_tmp;
1364                                         LOG_DEBUG("\tend_state = %s", tap_state_name(i_tmp));
1365                                 } else {
1366                                         LOG_ERROR("%s: %s is not a stable state", argus[0], tap_state_name(i_tmp));
1367                                         return ERROR_FAIL;
1368                                 }
1369                                 i += 2;
1370                         }
1371
1372                         /* all parameter should be parsed */
1373                         if (i == num_of_argu) {
1374 #if 1
1375                                 /* FIXME handle statemove failures */
1376                                 uint32_t min_usec = 1000000 * min_time;
1377
1378                                 /* enter into run_state if necessary */
1379                                 if (cmd_queue_cur_state != svf_para.runtest_run_state)
1380                                         svf_add_statemove(svf_para.runtest_run_state);
1381
1382                                 /* add clocks and/or min wait */
1383                                 if (run_count > 0) {
1384                                         if (!svf_nil)
1385                                                 jtag_add_clocks(run_count);
1386                                 }
1387
1388                                 if (min_usec > 0) {
1389                                         if (!svf_nil)
1390                                                 jtag_add_sleep(min_usec);
1391                                 }
1392
1393                                 /* move to end_state if necessary */
1394                                 if (svf_para.runtest_end_state != svf_para.runtest_run_state)
1395                                         svf_add_statemove(svf_para.runtest_end_state);
1396
1397 #else
1398                                 if (svf_para.runtest_run_state != TAP_IDLE) {
1399                                         LOG_ERROR("cannot runtest in %s state",
1400                                                         tap_state_name(svf_para.runtest_run_state));
1401                                         return ERROR_FAIL;
1402                                 }
1403
1404                                 if (!svf_nil)
1405                                         jtag_add_runtest(run_count, svf_para.runtest_end_state);
1406 #endif
1407                         } else {
1408                                 LOG_ERROR("fail to parse parameter of RUNTEST, %d out of %d is parsed",
1409                                                 i,
1410                                                 num_of_argu);
1411                                 return ERROR_FAIL;
1412                         }
1413                         break;
1414                 case STATE:
1415                         /* STATE [pathstate1 [pathstate2 ...[pathstaten]]] stable_state */
1416                         if (num_of_argu < 2) {
1417                                 LOG_ERROR("invalid parameter of %s", argus[0]);
1418                                 return ERROR_FAIL;
1419                         }
1420                         if (num_of_argu > 2) {
1421                                 /* STATE pathstate1 ... stable_state */
1422                                 path = malloc((num_of_argu - 1) * sizeof(tap_state_t));
1423                                 if (!path) {
1424                                         LOG_ERROR("not enough memory");
1425                                         return ERROR_FAIL;
1426                                 }
1427                                 num_of_argu--;  /* num of path */
1428                                 i_tmp = 1;              /* path is from parameter 1 */
1429                                 for (i = 0; i < num_of_argu; i++, i_tmp++) {
1430                                         path[i] = tap_state_by_name(argus[i_tmp]);
1431                                         if (path[i] == TAP_INVALID) {
1432                                                 LOG_ERROR("%s: %s is not a valid state", argus[0], argus[i_tmp]);
1433                                                 free(path);
1434                                                 return ERROR_FAIL;
1435                                         }
1436                                         /* OpenOCD refuses paths containing TAP_RESET */
1437                                         if (TAP_RESET == path[i]) {
1438                                                 /* FIXME last state MUST be stable! */
1439                                                 if (i > 0) {
1440                                                         if (!svf_nil)
1441                                                                 jtag_add_pathmove(i, path);
1442                                                 }
1443                                                 if (!svf_nil)
1444                                                         jtag_add_tlr();
1445                                                 num_of_argu -= i + 1;
1446                                                 i = -1;
1447                                         }
1448                                 }
1449                                 if (num_of_argu > 0) {
1450                                         /* execute last path if necessary */
1451                                         if (svf_tap_state_is_stable(path[num_of_argu - 1])) {
1452                                                 /* last state MUST be stable state */
1453                                                 if (!svf_nil)
1454                                                         jtag_add_pathmove(num_of_argu, path);
1455                                                 LOG_DEBUG("\tmove to %s by path_move",
1456                                                                 tap_state_name(path[num_of_argu - 1]));
1457                                         } else {
1458                                                 LOG_ERROR("%s: %s is not a stable state",
1459                                                                 argus[0],
1460                                                                 tap_state_name(path[num_of_argu - 1]));
1461                                                 free(path);
1462                                                 return ERROR_FAIL;
1463                                         }
1464                                 }
1465
1466                                 free(path);
1467                                 path = NULL;
1468                         } else {
1469                                 /* STATE stable_state */
1470                                 state = tap_state_by_name(argus[1]);
1471                                 if (svf_tap_state_is_stable(state)) {
1472                                         LOG_DEBUG("\tmove to %s by svf_add_statemove",
1473                                                         tap_state_name(state));
1474                                         /* FIXME handle statemove failures */
1475                                         svf_add_statemove(state);
1476                                 } else {
1477                                         LOG_ERROR("%s: %s is not a stable state",
1478                                                         argus[0], tap_state_name(state));
1479                                         return ERROR_FAIL;
1480                                 }
1481                         }
1482                         break;
1483                 case TRST:
1484                         /* TRST trst_mode */
1485                         if (num_of_argu != 2) {
1486                                 LOG_ERROR("invalid parameter of %s", argus[0]);
1487                                 return ERROR_FAIL;
1488                         }
1489                         if (svf_para.trst_mode != TRST_ABSENT) {
1490                                 if (ERROR_OK != svf_execute_tap())
1491                                         return ERROR_FAIL;
1492                                 i_tmp = svf_find_string_in_array(argus[1],
1493                                                 (char **)svf_trst_mode_name,
1494                                                 ARRAY_SIZE(svf_trst_mode_name));
1495                                 switch (i_tmp) {
1496                                 case TRST_ON:
1497                                         if (!svf_nil)
1498                                                 jtag_add_reset(1, 0);
1499                                         break;
1500                                 case TRST_Z:
1501                                 case TRST_OFF:
1502                                         if (!svf_nil)
1503                                                 jtag_add_reset(0, 0);
1504                                         break;
1505                                 case TRST_ABSENT:
1506                                         break;
1507                                 default:
1508                                         LOG_ERROR("unknown TRST mode: %s", argus[1]);
1509                                         return ERROR_FAIL;
1510                                 }
1511                                 svf_para.trst_mode = i_tmp;
1512                                 LOG_DEBUG("\ttrst_mode = %s", svf_trst_mode_name[svf_para.trst_mode]);
1513                         } else {
1514                                 LOG_ERROR("can not accept TRST command if trst_mode is ABSENT");
1515                                 return ERROR_FAIL;
1516                         }
1517                         break;
1518                 default:
1519                         LOG_ERROR("invalid svf command: %s", argus[0]);
1520                         return ERROR_FAIL;
1521         }
1522
1523         if (!svf_quiet) {
1524                 if (padding_command_skipped)
1525                         LOG_USER("(Above Padding command skipped, as per -tap argument)");
1526         }
1527
1528         if (debug_level >= LOG_LVL_DEBUG) {
1529                 /* for convenient debugging, execute tap if possible */
1530                 if ((svf_buffer_index > 0) &&
1531                                 (((command != STATE) && (command != RUNTEST)) ||
1532                                                 ((command == STATE) && (num_of_argu == 2)))) {
1533                         if (ERROR_OK != svf_execute_tap())
1534                                 return ERROR_FAIL;
1535
1536                         /* output debug info */
1537                         if ((command == SIR) || (command == SDR))
1538                                 SVF_BUF_LOG(DEBUG, svf_tdi_buffer, svf_check_tdo_para[0].bit_len, "TDO read");
1539                 }
1540         } else {
1541                 /* for fast executing, execute tap if necessary */
1542                 /* half of the buffer is for the next command */
1543                 if (((svf_buffer_index >= SVF_MAX_BUFFER_SIZE_TO_COMMIT) ||
1544                                 (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE / 2)) &&
1545                                 (((command != STATE) && (command != RUNTEST)) ||
1546                                                 ((command == STATE) && (num_of_argu == 2))))
1547                         return svf_execute_tap();
1548         }
1549
1550         return ERROR_OK;
1551 }
1552
1553 static const struct command_registration svf_command_handlers[] = {
1554         {
1555                 .name = "svf",
1556                 .handler = handle_svf_command,
1557                 .mode = COMMAND_EXEC,
1558                 .help = "Runs a SVF file.",
1559                 .usage = "[-tap device.tap] <file> [quiet] [nil] [progress] [ignore_error]",
1560         },
1561         COMMAND_REGISTRATION_DONE
1562 };
1563
1564 int svf_register_commands(struct command_context *cmd_ctx)
1565 {
1566         return register_commands(cmd_ctx, NULL, svf_command_handlers);
1567 }