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, write to the                                             *
  17  *       Free Software Foundation, Inc.,                                                                           *
  18  *       59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.                         *
  19  ***************************************************************************/
  20
  21
  22 /* The specification for SVF is available here:
  23  * http://www.asset-intertech.com/support/svf.pdf
  24  * Below, this document is refered to as the "SVF spec".
  25  *
  26  * The specification for XSVF is available here:
  27  * http://www.xilinx.com/support/documentation/application_notes/xapp503.pdf
  28  * Below, this document is refered to as the "XSVF spec".
  29  */
  30
  31 #ifdef HAVE_CONFIG_H
  32 #include "config.h"
  33 #endif
  34
  35 #include "svf.h"
  36 #include "jtag.h"
  37 #include "time_support.h"
  38
  39
  40 // SVF command
  41 typedef enum
  42 {
  43         ENDDR,
  44         ENDIR,
  45         FREQUENCY,
  46         HDR,
  47         HIR,
  48         PIO,
  49         PIOMAP,
  50         RUNTEST,
  51         SDR,
  52         SIR,
  53         STATE,
  54         TDR,
  55         TIR,
  56         TRST,
  57 }svf_command_t;
  58
  59 const char *svf_command_name[14] =
  60 {
  61         "ENDDR",
  62         "ENDIR",
  63         "FREQUENCY",
  64         "HDR",
  65         "HIR",
  66         "PIO",
  67         "PIOMAP",
  68         "RUNTEST",
  69         "SDR",
  70         "SIR",
  71         "STATE",
  72         "TDR",
  73         "TIR",
  74         "TRST"
  75 };
  76
  77 typedef enum
  78 {
  79         TRST_ON,
  80         TRST_OFF,
  81         TRST_Z,
  82         TRST_ABSENT
  83 }trst_mode_t;
  84
  85 const char *svf_trst_mode_name[4] =
  86 {
  87         "ON",
  88         "OFF",
  89         "Z",
  90         "ABSENT"
  91 };
  92
  93 char *svf_tap_state_name[TAP_NUM_STATES];
  94
  95 #define XXR_TDI                                         (1 << 0)
  96 #define XXR_TDO                                         (1 << 1)
  97 #define XXR_MASK                                        (1 << 2)
  98 #define XXR_SMASK                                       (1 << 3)
  99 typedef struct
 100 {
 101         int len;
 102         int data_mask;
 103         u8 *tdi;
 104         u8 *tdo;
 105         u8 *mask;
 106         u8 *smask;
 107 }svf_xxr_para_t;
 108
 109 typedef struct
 110 {
 111         float frequency;
 112         tap_state_t ir_end_state;
 113         tap_state_t dr_end_state;
 114         tap_state_t runtest_run_state;
 115         tap_state_t runtest_end_state;
 116         trst_mode_t trst_mode;
 117
 118         svf_xxr_para_t hir_para;
 119         svf_xxr_para_t hdr_para;
 120         svf_xxr_para_t tir_para;
 121         svf_xxr_para_t tdr_para;
 122         svf_xxr_para_t sir_para;
 123         svf_xxr_para_t sdr_para;
 124 }svf_para_t;
 125
 126 svf_para_t svf_para;
 127 const svf_para_t svf_para_init =
 128 {
 129 //      frequency,      ir_end_state,   dr_end_state,   runtest_run_state,      runtest_end_state,      trst_mode
 130         0,                      TAP_IDLE,               TAP_IDLE,               TAP_IDLE,                       TAP_IDLE,                       TRST_Z,
 131 //      hir_para
 132 //      {len,   data_mask,      tdi,    tdo,    mask,   smask},
 133         {0,             0,                      NULL,   NULL,   NULL,   NULL},
 134 //      hdr_para
 135 //      {len,   data_mask,      tdi,    tdo,    mask,   smask},
 136         {0,             0,                      NULL,   NULL,   NULL,   NULL},
 137 //      tir_para
 138 //      {len,   data_mask,      tdi,    tdo,    mask,   smask},
 139         {0,             0,                      NULL,   NULL,   NULL,   NULL},
 140 //      tdr_para
 141 //      {len,   data_mask,      tdi,    tdo,    mask,   smask},
 142         {0,             0,                      NULL,   NULL,   NULL,   NULL},
 143 //      sir_para
 144 //      {len,   data_mask,      tdi,    tdo,    mask,   smask},
 145         {0,             0,                      NULL,   NULL,   NULL,   NULL},
 146 //      sdr_para
 147 //      {len,   data_mask,      tdi,    tdo,    mask,   smask},
 148         {0,             0,                      NULL,   NULL,   NULL,   NULL},
 149 };
 150
 151 typedef struct
 152 {
 153         int line_num;           // used to record line number of the check operation
 154                                                 // so more information could be printed
 155         int enabled;            // check is enabled or not
 156         int buffer_offset;      // buffer_offset to buffers
 157         int bit_len;            // bit length to check
 158 }svf_check_tdo_para_t;
 159
 160 #define SVF_CHECK_TDO_PARA_SIZE 1024
 161 static svf_check_tdo_para_t *svf_check_tdo_para = NULL;
 162 static int svf_check_tdo_para_index = 0;
 163
 164 #define dimof(a)                                        (sizeof(a) / sizeof((a)[0]))
 165
 166 static int svf_read_command_from_file(int fd);
 167 static int svf_check_tdo(void);
 168 static int svf_add_check_para(u8 enabled, int buffer_offset, int bit_len);
 169 static int svf_run_command(struct command_context_s *cmd_ctx, char *cmd_str);
 170 static int handle_svf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 171
 172 static int svf_fd = 0;
 173 static char *svf_command_buffer = NULL;
 174 static int svf_command_buffer_size = 0;
 175 static int svf_line_number = 1;
 176
 177 static jtag_tap_t *tap = NULL;
 178 static tap_state_t last_state = TAP_RESET;
 179
 180 #define SVF_MAX_BUFFER_SIZE_TO_COMMIT   (4 * 1024)
 181 static u8 *svf_tdi_buffer = NULL, *svf_tdo_buffer = NULL, *svf_mask_buffer = NULL;
 182 static int svf_buffer_index = 0, svf_buffer_size = 0;
 183 static int svf_quiet = 0;
 184
 185
 186 int svf_register_commands(struct command_context_s *cmd_ctx)
 187 {
 188         register_command(cmd_ctx, NULL, "svf", handle_svf_command,
 189                 COMMAND_EXEC, "run svf <file>");
 190
 191         return ERROR_OK;
 192 }
 193
 194 void svf_free_xxd_para(svf_xxr_para_t *para)
 195 {
 196         if (NULL != para)
 197         {
 198                 if (para->tdi != NULL)
 199                 {
 200                         free(para->tdi);
 201                         para->tdi = NULL;
 202                 }
 203                 if (para->tdo != NULL)
 204                 {
 205                         free(para->tdo);
 206                         para->tdo = NULL;
 207                 }
 208                 if (para->mask != NULL)
 209                 {
 210                         free(para->mask);
 211                         para->mask = NULL;
 212                 }
 213                 if (para->smask != NULL)
 214                 {
 215                         free(para->smask);
 216                         para->smask = NULL;
 217                 }
 218         }
 219 }
 220
 221 unsigned svf_get_mask_u32(int bitlen)
 222 {
 223         u32 bitmask;
 224
 225         if (bitlen < 0)
 226         {
 227                 bitmask = 0;
 228         }
 229         else if (bitlen >= 32)
 230         {
 231                 bitmask = 0xFFFFFFFF;
 232         }
 233         else
 234         {
 235                 bitmask = (1 << bitlen) - 1;
 236         }
 237
 238         return bitmask;
 239 }
 240
 241 static const char* tap_state_svf_name(tap_state_t state)
 242 {
 243         const char* ret;
 244
 245         switch( state )
 246         {
 247         case TAP_RESET:         ret = "RESET";          break;
 248         case TAP_IDLE:          ret = "IDLE";           break;
 249         case TAP_DRSELECT:      ret = "DRSELECT";       break;
 250         case TAP_DRCAPTURE: ret = "DRCAPTURE";  break;
 251         case TAP_DRSHIFT:       ret = "DRSHIFT";        break;
 252         case TAP_DREXIT1:       ret = "DREXIT1";        break;
 253         case TAP_DRPAUSE:       ret = "DRPAUSE";        break;
 254         case TAP_DREXIT2:       ret = "DREXIT2";        break;
 255         case TAP_DRUPDATE:      ret = "DRUPDATE";       break;
 256         case TAP_IRSELECT:      ret = "IRSELECT";       break;
 257         case TAP_IRCAPTURE: ret = "IRCAPTURE";  break;
 258         case TAP_IRSHIFT:       ret = "IRSHIFT";        break;
 259         case TAP_IREXIT1:       ret = "IREXIT1";        break;
 260         case TAP_IRPAUSE:       ret = "IRPAUSE";        break;
 261         case TAP_IREXIT2:       ret = "IREXIT2";        break;
 262         case TAP_IRUPDATE:      ret = "IRUPDATE";       break;
 263         default:                        ret = "???";            break;
 264         }
 265
 266         return ret;
 267 }
 268
 269 static int handle_svf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 270 {
 271 #define SVF_NUM_OF_OPTIONS                      1
 272         int command_num = 0, i;
 273         int ret = ERROR_OK;
 274         long long time_ago;
 275
 276         if ((argc < 1) || (argc > (1 + SVF_NUM_OF_OPTIONS)))
 277         {
 278                 command_print(cmd_ctx, "usage: svf <file> [quiet]");
 279                 return ERROR_FAIL;
 280         }
 281
 282         // parse variant
 283         svf_quiet = 0;
 284         for (i = 1; i < argc; i++)
 285         {
 286                 if (!strcmp(args[i], "quiet"))
 287                 {
 288                         svf_quiet = 1;
 289                 }
 290                 else
 291                 {
 292                         LOG_ERROR("unknown variant for svf: %s", args[i]);
 293
 294                         // no need to free anything now
 295                         return ERROR_FAIL;
 296                 }
 297         }
 298
 299         if ((svf_fd = open(args[0], O_RDONLY)) < 0)
 300         {
 301                 command_print(cmd_ctx, "file \"%s\" not found", args[0]);
 302
 303                 // no need to free anything now
 304                 return ERROR_FAIL;
 305         }
 306
 307         LOG_USER("svf processing file: \"%s\"", args[0]);
 308
 309         // get time
 310         time_ago = timeval_ms();
 311
 312         // init
 313         svf_line_number = 1;
 314         svf_command_buffer_size = 0;
 315
 316         svf_check_tdo_para_index = 0;
 317         svf_check_tdo_para = malloc(sizeof(svf_check_tdo_para_t) * SVF_CHECK_TDO_PARA_SIZE);
 318         if (NULL == svf_check_tdo_para)
 319         {
 320                 LOG_ERROR("not enough memory");
 321                 ret = ERROR_FAIL;
 322                 goto free_all;
 323         }
 324
 325         svf_buffer_index = 0;
 326         // double the buffer size
 327         // in case current command cannot be commited, and next command is a bit scan command
 328         // here is 32K bits for this big scan command, it should be enough
 329         // buffer will be reallocated if buffer size is not enough
 330         svf_tdi_buffer = (u8 *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
 331         if (NULL == svf_tdi_buffer)
 332         {
 333                 LOG_ERROR("not enough memory");
 334                 ret = ERROR_FAIL;
 335                 goto free_all;
 336         }
 337         svf_tdo_buffer = (u8 *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
 338         if (NULL == svf_tdo_buffer)
 339         {
 340                 LOG_ERROR("not enough memory");
 341                 ret = ERROR_FAIL;
 342                 goto free_all;
 343         }
 344         svf_mask_buffer = (u8 *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
 345         if (NULL == svf_mask_buffer)
 346         {
 347                 LOG_ERROR("not enough memory");
 348                 ret = ERROR_FAIL;
 349                 goto free_all;
 350         }
 351         svf_buffer_size = 2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT;
 352
 353         memcpy(&svf_para, &svf_para_init, sizeof(svf_para));
 354         for (i = 0; i < (int)dimof(svf_tap_state_name); i++)
 355         {
 356                 svf_tap_state_name[i] = (char *)tap_state_svf_name(i);
 357         }
 358         // TAP_RESET
 359         jtag_add_tlr();
 360
 361         while ( ERROR_OK == svf_read_command_from_file(svf_fd) )
 362         {
 363                 if (ERROR_OK != svf_run_command(cmd_ctx, svf_command_buffer))
 364                 {
 365                         LOG_ERROR("fail to run command at line %d", svf_line_number);
 366                         ret = ERROR_FAIL;
 367                         break;
 368                 }
 369                 command_num++;
 370         }
 371         if (ERROR_OK != jtag_execute_queue())
 372         {
 373                 ret = ERROR_FAIL;
 374         }
 375         else if (ERROR_OK != svf_check_tdo())
 376         {
 377                 ret = ERROR_FAIL;
 378         }
 379
 380         // print time
 381         command_print(cmd_ctx, "%lld ms used", timeval_ms() - time_ago);
 382
 383 free_all:
 384
 385         close(svf_fd);
 386         svf_fd = 0;
 387
 388         // free buffers
 389         if (svf_command_buffer)
 390         {
 391                 free(svf_command_buffer);
 392                 svf_command_buffer = NULL;
 393                 svf_command_buffer_size = 0;
 394         }
 395         if (svf_check_tdo_para)
 396         {
 397                 free(svf_check_tdo_para);
 398                 svf_check_tdo_para = NULL;
 399                 svf_check_tdo_para_index = 0;
 400         }
 401         if (svf_tdi_buffer)
 402         {
 403                 free(svf_tdi_buffer);
 404                 svf_tdi_buffer = NULL;
 405         }
 406         if (svf_tdo_buffer)
 407         {
 408                 free(svf_tdo_buffer);
 409                 svf_tdo_buffer = NULL;
 410         }
 411         if (svf_mask_buffer)
 412         {
 413                 free(svf_mask_buffer);
 414                 svf_mask_buffer = NULL;
 415         }
 416         svf_buffer_index = 0;
 417         svf_buffer_size = 0;
 418
 419         svf_free_xxd_para(&svf_para.hdr_para);
 420         svf_free_xxd_para(&svf_para.hir_para);
 421         svf_free_xxd_para(&svf_para.tdr_para);
 422         svf_free_xxd_para(&svf_para.tir_para);
 423         svf_free_xxd_para(&svf_para.sdr_para);
 424         svf_free_xxd_para(&svf_para.sir_para);
 425
 426         if (ERROR_OK == ret)
 427         {
 428                 command_print(cmd_ctx, "svf file programmed successfully for %d commands", command_num);
 429         }
 430         else
 431         {
 432                 command_print(cmd_ctx, "svf file programmed failed");
 433         }
 434
 435         return ret;
 436 }
 437
 438 #define SVFP_CMD_INC_CNT                        1024
 439 static int svf_read_command_from_file(int fd)
 440 {
 441         char ch, *tmp_buffer = NULL;
 442         int cmd_pos = 0, cmd_ok = 0, slash = 0, comment = 0;
 443
 444         while (!cmd_ok && (read(fd, &ch, 1) > 0) )
 445         {
 446                 switch(ch)
 447                 {
 448                 case '!':
 449                         slash = 0;
 450                         comment = 1;
 451                         break;
 452                 case '/':
 453                         if (++slash == 2)
 454                         {
 455                                 comment = 1;
 456                         }
 457                         break;
 458                 case ';':
 459                         slash = 0;
 460                         if (!comment)
 461                         {
 462                                 cmd_ok = 1;
 463                         }
 464                         break;
 465                 case '\n':
 466                         svf_line_number++;
 467                 case '\r':
 468                         slash = 0;
 469                         comment = 0;
 470                         break;
 471                 default:
 472                         if (!comment)
 473                         {
 474                                 if (cmd_pos >= svf_command_buffer_size - 1)
 475                                 {
 476                                         tmp_buffer = (char*)malloc(svf_command_buffer_size + SVFP_CMD_INC_CNT);         // 1 more byte for '\0'
 477                                         if (NULL == tmp_buffer)
 478                                         {
 479                                                 LOG_ERROR("not enough memory");
 480                                                 return ERROR_FAIL;
 481                                         }
 482                                         if (svf_command_buffer_size > 0)
 483                                         {
 484                                                 memcpy(tmp_buffer, svf_command_buffer, svf_command_buffer_size);
 485                                         }
 486                                         if (svf_command_buffer != NULL)
 487                                         {
 488                                                 free(svf_command_buffer);
 489                                         }
 490                                         svf_command_buffer = tmp_buffer;
 491                                         svf_command_buffer_size += SVFP_CMD_INC_CNT;
 492                                         tmp_buffer = NULL;
 493                                 }
 494                                 svf_command_buffer[cmd_pos++] = (char)toupper(ch);
 495                         }
 496                         break;
 497                 }
 498         }
 499
 500         if (cmd_ok)
 501         {
 502                 svf_command_buffer[cmd_pos] = '\0';
 503                 return ERROR_OK;
 504         }
 505         else
 506         {
 507                 return ERROR_FAIL;
 508         }
 509 }
 510
 511 static int svf_parse_cmd_string(char *str, int len, char **argus, int *num_of_argu)
 512 {
 513         int pos = 0, num = 0, space_found = 1;
 514
 515         while (pos < len)
 516         {
 517                 switch(str[pos])
 518                 {
 519                 case '\n':
 520                 case '\r':
 521                 case '!':
 522                 case '/':
 523                         LOG_ERROR("fail to parse svf command");
 524                         return ERROR_FAIL;
 525                         break;
 526                 case ' ':
 527                         space_found = 1;
 528                         str[pos] = '\0';
 529                         break;
 530                 default:
 531                         if (space_found)
 532                         {
 533                                 argus[num++] = &str[pos];
 534                                 space_found = 0;
 535                         }
 536                         break;
 537                 }
 538                 pos++;
 539         }
 540
 541         *num_of_argu = num;
 542
 543         return ERROR_OK;
 544 }
 545
 546 static int svf_tap_state_is_stable(tap_state_t state)
 547 {
 548         return ((TAP_RESET == state) || (TAP_IDLE == state) || (TAP_DRPAUSE == state) || (TAP_IRPAUSE == state));
 549 }
 550
 551 static int svf_tap_state_is_valid(tap_state_t state)
 552 {
 553         return state >= 0 && state < TAP_NUM_STATES;
 554 }
 555
 556 static int svf_find_string_in_array(char *str, char **strs, int num_of_element)
 557 {
 558         int i;
 559
 560         for (i = 0; i < num_of_element; i++)
 561         {
 562                 if (!strcmp(str, strs[i]))
 563                 {
 564                         return i;
 565                 }
 566         }
 567         return 0xFF;
 568 }
 569
 570 static int svf_adjust_array_length(u8 **arr, int orig_bit_len, int new_bit_len)
 571 {
 572         int new_byte_len = (new_bit_len + 7) >> 3;
 573
 574         if ((NULL == *arr) || (((orig_bit_len + 7) >> 3) < ((new_bit_len + 7) >> 3)))
 575         {
 576                 if (*arr != NULL)
 577                 {
 578                         free(*arr);
 579                         *arr = NULL;
 580                 }
 581                 *arr = (u8*)malloc(new_byte_len);
 582                 if (NULL == *arr)
 583                 {
 584                         LOG_ERROR("not enough memory");
 585                         return ERROR_FAIL;
 586                 }
 587                 memset(*arr, 0, new_byte_len);
 588         }
 589         return ERROR_OK;
 590 }
 591
 592 static int svf_copy_hexstring_to_binary(char *str, u8 **bin, int orig_bit_len, int bit_len)
 593 {
 594         int i, str_len = strlen(str), str_byte_len = (bit_len + 3) >> 2, loop_cnt;
 595         u8 ch, need_write = 1;
 596
 597         if (ERROR_OK != svf_adjust_array_length(bin, orig_bit_len, bit_len))
 598         {
 599                 LOG_ERROR("fail to adjust length of array");
 600                 return ERROR_FAIL;
 601         }
 602
 603         if (str_byte_len > str_len)
 604         {
 605                 loop_cnt = str_byte_len;
 606         }
 607         else
 608         {
 609                 loop_cnt = str_len;
 610         }
 611
 612         for (i = 0; i < loop_cnt; i++)
 613         {
 614                 if (i < str_len)
 615                 {
 616                         ch = str[str_len - i - 1];
 617                         if ((ch >= '0') && (ch <= '9'))
 618                         {
 619                                 ch = ch - '0';
 620                         }
 621                         else if ((ch >= 'A') && (ch <= 'F'))
 622                         {
 623                                 ch = ch - 'A' + 10;
 624                         }
 625                         else
 626                         {
 627                                 LOG_ERROR("invalid hex string");
 628                                 return ERROR_FAIL;
 629                         }
 630                 }
 631                 else
 632                 {
 633                         ch = 0;
 634                 }
 635
 636                 // check valid
 637                 if (i >= str_byte_len)
 638                 {
 639                         // all data written, other data should be all '0's and needn't to be written
 640                         need_write = 0;
 641                         if (ch != 0)
 642                         {
 643                                 LOG_ERROR("value execede length");
 644                                 return ERROR_FAIL;
 645                         }
 646                 }
 647                 else if (i == (str_byte_len - 1))
 648                 {
 649                         // last data byte, written if valid
 650                         if ((ch & ~((1 << (bit_len - 4 * i)) - 1)) != 0)
 651                         {
 652                                 LOG_ERROR("value execede length");
 653                                 return ERROR_FAIL;
 654                         }
 655                 }
 656
 657                 if (need_write)
 658                 {
 659                         // write bin
 660                         if (i % 2)
 661                         {
 662                                 // MSB
 663                                 (*bin)[i / 2] |= ch << 4;
 664                         }
 665                         else
 666                         {
 667                                 // LSB
 668                                 (*bin)[i / 2] = 0;
 669                                 (*bin)[i / 2] |= ch;
 670                         }
 671                 }
 672         }
 673
 674         return ERROR_OK;
 675 }
 676
 677 static int svf_check_tdo(void)
 678 {
 679         int i, len, index;
 680
 681         for (i = 0; i < svf_check_tdo_para_index; i++)
 682         {
 683                 index = svf_check_tdo_para[i].buffer_offset;
 684                 len = svf_check_tdo_para[i].bit_len;
 685                 if ((svf_check_tdo_para[i].enabled)
 686                         && buf_cmp_mask(&svf_tdi_buffer[index], &svf_tdo_buffer[index], &svf_mask_buffer[index], len))
 687                 {
 688                         unsigned bitmask;
 689                         unsigned received, expected, tapmask;
 690                         bitmask = svf_get_mask_u32(svf_check_tdo_para[i].bit_len);
 691
 692                         memcpy(&received, svf_tdi_buffer + index, sizeof(unsigned));
 693                         memcpy(&expected, svf_tdo_buffer + index, sizeof(unsigned));
 694                         memcpy(&tapmask, svf_mask_buffer + index, sizeof(unsigned));
 695                         LOG_ERROR("tdo check error at line %d",
 696                                           svf_check_tdo_para[i].line_num);
 697                         LOG_ERROR("read = 0x%X, want = 0x%X, mask = 0x%X",
 698                                           received & bitmask,
 699                                           expected & bitmask,
 700                                           tapmask & bitmask);
 701                         return ERROR_FAIL;
 702                 }
 703         }
 704         svf_check_tdo_para_index = 0;
 705
 706         return ERROR_OK;
 707 }
 708
 709 static int svf_add_check_para(u8 enabled, int buffer_offset, int bit_len)
 710 {
 711         if (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE)
 712         {
 713                 LOG_ERROR("toooooo many operation undone");
 714                 return ERROR_FAIL;
 715         }
 716
 717         svf_check_tdo_para[svf_check_tdo_para_index].line_num = svf_line_number;
 718         svf_check_tdo_para[svf_check_tdo_para_index].bit_len = bit_len;
 719         svf_check_tdo_para[svf_check_tdo_para_index].enabled = enabled;
 720         svf_check_tdo_para[svf_check_tdo_para_index].buffer_offset = buffer_offset;
 721         svf_check_tdo_para_index++;
 722
 723         return ERROR_OK;
 724 }
 725
 726 static int svf_execute_tap(void)
 727 {
 728         if (ERROR_OK != jtag_execute_queue())
 729         {
 730                 return ERROR_FAIL;
 731         }
 732         else if (ERROR_OK != svf_check_tdo())
 733         {
 734                 return ERROR_FAIL;
 735         }
 736
 737         svf_buffer_index = 0;
 738
 739         return ERROR_OK;
 740 }
 741
 742 // not good to use this
 743 extern void* cmd_queue_alloc(size_t size);
 744 extern void jtag_queue_command(jtag_command_t * cmd);
 745
 746 static int svf_run_command(struct command_context_s *cmd_ctx, char *cmd_str)
 747 {
 748         char *argus[256], command;
 749         int num_of_argu = 0, i;
 750
 751         // tmp variable
 752         int i_tmp;
 753
 754         // for RUNTEST
 755         int run_count;
 756         float min_time, max_time;
 757         // for XXR
 758         svf_xxr_para_t *xxr_para_tmp;
 759         u8 **pbuffer_tmp;
 760         scan_field_t field;
 761         // for STATE
 762         tap_state_t *path = NULL, state;
 763
 764         if (!svf_quiet)
 765         {
 766                 LOG_USER("%s", svf_command_buffer);
 767         }
 768
 769         if (ERROR_OK != svf_parse_cmd_string(cmd_str, strlen(cmd_str), argus, &num_of_argu))
 770         {
 771                 return ERROR_FAIL;
 772         }
 773
 774         command = svf_find_string_in_array(argus[0], (char **)svf_command_name, dimof(svf_command_name));
 775         switch(command)
 776         {
 777         case ENDDR:
 778         case ENDIR:
 779                 if (num_of_argu != 2)
 780                 {
 781                         LOG_ERROR("invalid parameter of %s", argus[0]);
 782                         return ERROR_FAIL;
 783                 }
 784                 i_tmp = svf_find_string_in_array(argus[1], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
 785                 if (svf_tap_state_is_stable(i_tmp))
 786                 {
 787                         if (command == ENDIR)
 788                         {
 789                                 svf_para.ir_end_state = i_tmp;
 790                                 LOG_DEBUG("\tir_end_state = %s", svf_tap_state_name[svf_para.ir_end_state]);
 791                         }
 792                         else
 793                         {
 794                                 svf_para.dr_end_state = i_tmp;
 795                                 LOG_DEBUG("\tdr_end_state = %s", svf_tap_state_name[svf_para.dr_end_state]);
 796                         }
 797                 }
 798                 else
 799                 {
 800                         LOG_ERROR("%s is not valid state", argus[1]);
 801                         return ERROR_FAIL;
 802                 }
 803                 break;
 804         case FREQUENCY:
 805                 if ((num_of_argu != 1) && (num_of_argu != 3))
 806                 {
 807                         LOG_ERROR("invalid parameter of %s", argus[0]);
 808                         return ERROR_FAIL;
 809                 }
 810                 if (1 == num_of_argu)
 811                 {
 812                         // TODO: set jtag speed to full speed
 813                         svf_para.frequency = 0;
 814                 }
 815                 else
 816                 {
 817                         if (strcmp(argus[2], "HZ"))
 818                         {
 819                                 LOG_ERROR("HZ not found in FREQUENCY command");
 820                                 return ERROR_FAIL;
 821                         }
 822                         if (ERROR_OK != svf_execute_tap())
 823                         {
 824                                 return ERROR_FAIL;
 825                         }
 826                         svf_para.frequency = atof(argus[1]);
 827                         // TODO: set jtag speed to
 828                         if (svf_para.frequency > 0)
 829                         {
 830                                 command_run_linef(cmd_ctx, "jtag_khz %d", (int)svf_para.frequency / 1000);
 831                                 LOG_DEBUG("\tfrequency = %f", svf_para.frequency);
 832                         }
 833                 }
 834                 break;
 835         case HDR:
 836                 xxr_para_tmp = &svf_para.hdr_para;
 837                 goto XXR_common;
 838         case HIR:
 839                 xxr_para_tmp = &svf_para.hir_para;
 840                 goto XXR_common;
 841         case TDR:
 842                 xxr_para_tmp = &svf_para.tdr_para;
 843                 goto XXR_common;
 844         case TIR:
 845                 xxr_para_tmp = &svf_para.tir_para;
 846                 goto XXR_common;
 847         case SDR:
 848                 xxr_para_tmp = &svf_para.sdr_para;
 849                 goto XXR_common;
 850         case SIR:
 851                 xxr_para_tmp = &svf_para.sir_para;
 852                 goto XXR_common;
 853                 XXR_common:
 854                 // XXR length [TDI (tdi)] [TDO (tdo)][MASK (mask)] [SMASK (smask)]
 855                 if ((num_of_argu > 10) || (num_of_argu % 2))
 856                 {
 857                         LOG_ERROR("invalid parameter of %s", argus[0]);
 858                         return ERROR_FAIL;
 859                 }
 860                 i_tmp = xxr_para_tmp->len;
 861                 xxr_para_tmp->len = atoi(argus[1]);
 862                 LOG_DEBUG("\tlength = %d", xxr_para_tmp->len);
 863                 xxr_para_tmp->data_mask = 0;
 864                 for (i = 2; i < num_of_argu; i += 2)
 865                 {
 866                         if ((strlen(argus[i + 1]) < 3) || (argus[i + 1][0] != '(') || (argus[i + 1][strlen(argus[i + 1]) - 1] != ')'))
 867                         {
 868                                 LOG_ERROR("data section error");
 869                                 return ERROR_FAIL;
 870                         }
 871                         argus[i + 1][strlen(argus[i + 1]) - 1] = '\0';
 872                         // TDI, TDO, MASK, SMASK
 873                         if (!strcmp(argus[i], "TDI"))
 874                         {
 875                                 // TDI
 876                                 pbuffer_tmp = &xxr_para_tmp->tdi;
 877                                 xxr_para_tmp->data_mask |= XXR_TDI;
 878                         }
 879                         else if (!strcmp(argus[i], "TDO"))
 880                         {
 881                                 // TDO
 882                                 pbuffer_tmp = &xxr_para_tmp->tdo;
 883                                 xxr_para_tmp->data_mask |= XXR_TDO;
 884                         }
 885                         else if (!strcmp(argus[i], "MASK"))
 886                         {
 887                                 // MASK
 888                                 pbuffer_tmp = &xxr_para_tmp->mask;
 889                                 xxr_para_tmp->data_mask |= XXR_MASK;
 890                         }
 891                         else if (!strcmp(argus[i], "SMASK"))
 892                         {
 893                                 // SMASK
 894                                 pbuffer_tmp = &xxr_para_tmp->smask;
 895                                 xxr_para_tmp->data_mask |= XXR_SMASK;
 896                         }
 897                         else
 898                         {
 899                                 LOG_ERROR("unknow parameter: %s", argus[i]);
 900                                 return ERROR_FAIL;
 901                         }
 902                         if (ERROR_OK != svf_copy_hexstring_to_binary(&argus[i + 1][1], pbuffer_tmp, i_tmp, xxr_para_tmp->len))
 903                         {
 904                                 LOG_ERROR("fail to parse hex value");
 905                                 return ERROR_FAIL;
 906                         }
 907                         LOG_DEBUG("\t%s = 0x%X", argus[i], (**(int**)pbuffer_tmp) & svf_get_mask_u32(xxr_para_tmp->len));
 908                 }
 909                 // If a command changes the length of the last scan of the same type and the MASK parameter is absent,
 910                 // the mask pattern used is all cares
 911                 if (!(xxr_para_tmp->data_mask & XXR_MASK) && (i_tmp != xxr_para_tmp->len))
 912                 {
 913                         // MASK not defined and length changed
 914                         if (ERROR_OK != svf_adjust_array_length(&xxr_para_tmp->mask, i_tmp, xxr_para_tmp->len))
 915                         {
 916                                 LOG_ERROR("fail to adjust length of array");
 917                                 return ERROR_FAIL;
 918                         }
 919                         buf_set_ones(xxr_para_tmp->mask, xxr_para_tmp->len);
 920                 }
 921                 // do scan if necessary
 922                 if (SDR == command)
 923                 {
 924                         // check buffer size first, reallocate if necessary
 925                         i = svf_para.hdr_para.len + svf_para.sdr_para.len + svf_para.tdr_para.len;
 926                         if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3))
 927                         {
 928 #if 1
 929                                 // simply print error message
 930                                 LOG_ERROR("buffer is not enough, report to author");
 931                                 return ERROR_FAIL;
 932 #else
 933                                 u8 *buffer_tmp;
 934
 935                                 // reallocate buffer
 936                                 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
 937                                 if (NULL == buffer_tmp)
 938                                 {
 939                                         LOG_ERROR("not enough memory");
 940                                         return ERROR_FAIL;
 941                                 }
 942                                 memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
 943                                 // svf_tdi_buffer isn't NULL here
 944                                 free(svf_tdi_buffer);
 945                                 svf_tdi_buffer = buffer_tmp;
 946
 947                                 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
 948                                 if (NULL == buffer_tmp)
 949                                 {
 950                                         LOG_ERROR("not enough memory");
 951                                         return ERROR_FAIL;
 952                                 }
 953                                 memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
 954                                 // svf_tdo_buffer isn't NULL here
 955                                 free(svf_tdo_buffer);
 956                                 svf_tdo_buffer = buffer_tmp;
 957
 958                                 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
 959                                 if (NULL == buffer_tmp)
 960                                 {
 961                                         LOG_ERROR("not enough memory");
 962                                         return ERROR_FAIL;
 963                                 }
 964                                 memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
 965                                 // svf_mask_buffer isn't NULL here
 966                                 free(svf_mask_buffer);
 967                                 svf_mask_buffer = buffer_tmp;
 968
 969                                 buffer_tmp = NULL;
 970                                 svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
 971 #endif
 972                         }
 973
 974                         // assemble dr data
 975                         i = 0;
 976                         buf_set_buf(svf_para.hdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
 977                         i += svf_para.hdr_para.len;
 978                         buf_set_buf(svf_para.sdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
 979                         i += svf_para.sdr_para.len;
 980                         buf_set_buf(svf_para.tdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
 981                         i += svf_para.tdr_para.len;
 982
 983                         // add check data
 984                         if (svf_para.sdr_para.data_mask & XXR_TDO)
 985                         {
 986                                 // assemble dr mask data
 987                                 i = 0;
 988                                 buf_set_buf(svf_para.hdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
 989                                 i += svf_para.hdr_para.len;
 990                                 buf_set_buf(svf_para.sdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
 991                                 i += svf_para.sdr_para.len;
 992                                 buf_set_buf(svf_para.tdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
 993                                 i += svf_para.tdr_para.len;
 994                                 // assemble dr check data
 995                                 i = 0;
 996                                 buf_set_buf(svf_para.hdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
 997                                 i += svf_para.hdr_para.len;
 998                                 buf_set_buf(svf_para.sdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
 999                                 i += svf_para.sdr_para.len;
1000                                 buf_set_buf(svf_para.tdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
1001                                 i += svf_para.tdr_para.len;
1002
1003                                 svf_add_check_para(1, svf_buffer_index, i);
1004                         }
1005                         else
1006                         {
1007                                 svf_add_check_para(0, svf_buffer_index, i);
1008                         }
1009                         field.tap = tap;
1010                         field.num_bits = i;
1011                         field.out_value = &svf_tdi_buffer[svf_buffer_index];
1012
1013                         field.in_value = &svf_tdi_buffer[svf_buffer_index];
1014
1015
1016
1017
1018                         jtag_add_plain_dr_scan(1, &field, svf_para.dr_end_state);
1019
1020                         svf_buffer_index += (i + 7) >> 3;
1021                         last_state = svf_para.dr_end_state;
1022                 }
1023                 else if (SIR == command)
1024                 {
1025                         // check buffer size first, reallocate if necessary
1026                         i = svf_para.hir_para.len + svf_para.sir_para.len + svf_para.tir_para.len;
1027                         if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3))
1028                         {
1029 #if 1
1030                                 // simply print error message
1031                                 LOG_ERROR("buffer is not enough, report to author");
1032                                 return ERROR_FAIL;
1033 #else
1034                                 u8 *buffer_tmp;
1035
1036                                 // reallocate buffer
1037                                 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
1038                                 if (NULL == buffer_tmp)
1039                                 {
1040                                         LOG_ERROR("not enough memory");
1041                                         return ERROR_FAIL;
1042                                 }
1043                                 memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
1044                                 // svf_tdi_buffer isn't NULL here
1045                                 free(svf_tdi_buffer);
1046                                 svf_tdi_buffer = buffer_tmp;
1047
1048                                 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
1049                                 if (NULL == buffer_tmp)
1050                                 {
1051                                         LOG_ERROR("not enough memory");
1052                                         return ERROR_FAIL;
1053                                 }
1054                                 memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
1055                                 // svf_tdo_buffer isn't NULL here
1056                                 free(svf_tdo_buffer);
1057                                 svf_tdo_buffer = buffer_tmp;
1058
1059                                 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
1060                                 if (NULL == buffer_tmp)
1061                                 {
1062                                         LOG_ERROR("not enough memory");
1063                                         return ERROR_FAIL;
1064                                 }
1065                                 memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
1066                                 // svf_mask_buffer isn't NULL here
1067                                 free(svf_mask_buffer);
1068                                 svf_mask_buffer = buffer_tmp;
1069
1070                                 buffer_tmp = NULL;
1071                                 svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
1072 #endif
1073                         }
1074
1075                         // assemble ir data
1076                         i = 0;
1077                         buf_set_buf(svf_para.hir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1078                         i += svf_para.hir_para.len;
1079                         buf_set_buf(svf_para.sir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1080                         i += svf_para.sir_para.len;
1081                         buf_set_buf(svf_para.tir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1082                         i += svf_para.tir_para.len;
1083
1084                         // add check data
1085                         if (svf_para.sir_para.data_mask & XXR_TDO)
1086                         {
1087                                 // assemble dr mask data
1088                                 i = 0;
1089                                 buf_set_buf(svf_para.hir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1090                                 i += svf_para.hir_para.len;
1091                                 buf_set_buf(svf_para.sir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1092                                 i += svf_para.sir_para.len;
1093                                 buf_set_buf(svf_para.tir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1094                                 i += svf_para.tir_para.len;
1095                                 // assemble dr check data
1096                                 i = 0;
1097                                 buf_set_buf(svf_para.hir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1098                                 i += svf_para.hir_para.len;
1099                                 buf_set_buf(svf_para.sir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1100                                 i += svf_para.sir_para.len;
1101                                 buf_set_buf(svf_para.tir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1102                                 i += svf_para.tir_para.len;
1103
1104                                 svf_add_check_para(1, svf_buffer_index, i);
1105                         }
1106                         else
1107                         {
1108                                 svf_add_check_para(0, svf_buffer_index, i);
1109                         }
1110                         field.tap = tap;
1111                         field.num_bits = i;
1112                         field.out_value = &svf_tdi_buffer[svf_buffer_index];
1113
1114                         field.in_value = &svf_tdi_buffer[svf_buffer_index];
1115
1116
1117
1118
1119                         jtag_add_plain_ir_scan(1, &field, svf_para.ir_end_state);
1120
1121                         svf_buffer_index += (i + 7) >> 3;
1122                         last_state = svf_para.ir_end_state;
1123                 }
1124                 break;
1125         case PIO:
1126         case PIOMAP:
1127                 LOG_ERROR("PIO and PIOMAP are not supported");
1128                 return ERROR_FAIL;
1129                 break;
1130         case RUNTEST:
1131                 // RUNTEST [run_state] run_count run_clk [min_time SEC [MAXIMUM max_time SEC]] [ENDSTATE end_state]
1132                 // RUNTEST [run_state] min_time SEC [MAXIMUM max_time SEC] [ENDSTATE end_state]
1133                 if ((num_of_argu < 3) && (num_of_argu > 11))
1134                 {
1135                         LOG_ERROR("invalid parameter of %s", argus[0]);
1136                         return ERROR_FAIL;
1137                 }
1138                 // init
1139                 run_count = 0;
1140                 min_time = 0;
1141                 max_time = 0;
1142                 i = 1;
1143                 // run_state
1144                 i_tmp = svf_find_string_in_array(argus[i], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1145                 if (svf_tap_state_is_valid(i_tmp))
1146                 {
1147                         if (svf_tap_state_is_stable(i_tmp))
1148                         {
1149                                 svf_para.runtest_run_state = i_tmp;
1150
1151                                 // When a run_state is specified, the new  run_state becomes the default end_state
1152                                 svf_para.runtest_end_state = i_tmp;
1153                                 LOG_DEBUG("\trun_state = %s", svf_tap_state_name[svf_para.runtest_run_state]);
1154                                 i++;
1155                         }
1156                         else
1157                         {
1158                                 LOG_ERROR("%s is not valid state", svf_tap_state_name[i_tmp]);
1159                                 return ERROR_FAIL;
1160                         }
1161                 }
1162                 // run_count run_clk
1163                 if (((i + 2) <= num_of_argu) && strcmp(argus[i + 1], "SEC"))
1164                 {
1165                         if (!strcmp(argus[i + 1], "TCK"))
1166                         {
1167                                 // clock source is TCK
1168                                 run_count = atoi(argus[i]);
1169                                 LOG_DEBUG("\trun_count@TCK = %d", run_count);
1170                         }
1171                         else
1172                         {
1173                                 LOG_ERROR("%s not supported for clock", argus[i + 1]);
1174                                 return ERROR_FAIL;
1175                         }
1176                         i += 2;
1177                 }
1178                 // min_time SEC
1179                 if (((i + 2) <= num_of_argu) && !strcmp(argus[i + 1], "SEC"))
1180                 {
1181                         min_time = atof(argus[i]);
1182                         LOG_DEBUG("\tmin_time = %fs", min_time);
1183                         i += 2;
1184                 }
1185                 // MAXIMUM max_time SEC
1186                 if (((i + 3) <= num_of_argu) && !strcmp(argus[i], "MAXIMUM") && !strcmp(argus[i + 2], "SEC"))
1187                 {
1188                         max_time = atof(argus[i + 1]);
1189                         LOG_DEBUG("\tmax_time = %fs", max_time);
1190                         i += 3;
1191                 }
1192                 // ENDSTATE end_state
1193                 if (((i + 2) <= num_of_argu) && !strcmp(argus[i], "ENDSTATE"))
1194                 {
1195                         i_tmp = svf_find_string_in_array(argus[i + 1], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1196                         if (svf_tap_state_is_stable(i_tmp))
1197                         {
1198                                 svf_para.runtest_end_state = i_tmp;
1199                                 LOG_DEBUG("\tend_state = %s", svf_tap_state_name[svf_para.runtest_end_state]);
1200                         }
1201                         else
1202                         {
1203                                 LOG_ERROR("%s is not valid state", svf_tap_state_name[i_tmp]);
1204                                 return ERROR_FAIL;
1205                         }
1206                         i += 2;
1207                 }
1208                 // calculate run_count
1209                 if ((0 == run_count) && (min_time > 0))
1210                 {
1211                         run_count = min_time * svf_para.frequency;
1212                 }
1213                 // all parameter should be parsed
1214                 if (i == num_of_argu)
1215                 {
1216                         if (run_count > 0)
1217                         {
1218                                 // run_state and end_state is checked to be stable state
1219                                 // TODO: do runtest
1220 #if 1
1221                                 // enter into run_state if necessary
1222                                 if (last_state != svf_para.runtest_run_state)
1223                                 {
1224                                         jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1225
1226                                         jtag_queue_command(cmd);
1227
1228                                         cmd->type = JTAG_STATEMOVE;
1229                                         cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1230                                         cmd->cmd.statemove->end_state = svf_para.runtest_run_state;
1231
1232                                         cmd_queue_end_state = cmd_queue_cur_state = cmd->cmd.statemove->end_state;
1233                                 }
1234
1235                                 // call jtag_add_clocks
1236                                 jtag_add_clocks(run_count);
1237
1238                                 if (svf_para.runtest_end_state != svf_para.runtest_run_state)
1239                                 {
1240                                         // move to end_state
1241                                         jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1242
1243                                         jtag_queue_command(cmd);
1244                                         cmd->type = JTAG_STATEMOVE;
1245                                         cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1246                                         cmd->cmd.statemove->end_state = svf_para.runtest_end_state;
1247
1248                                         cmd_queue_end_state = cmd_queue_cur_state = cmd->cmd.statemove->end_state;
1249                                 }
1250                                 last_state = svf_para.runtest_end_state;
1251 #else
1252                                 if (svf_para.runtest_run_state != TAP_IDLE)
1253                                 {
1254                                         // RUNTEST can only executed in TAP_IDLE
1255                                         LOG_ERROR("cannot runtest in %s state", svf_tap_state_name[svf_para.runtest_run_state]);
1256                                         return ERROR_FAIL;
1257                                 }
1258
1259                                 jtag_add_runtest(run_count, svf_para.runtest_end_state);
1260 #endif
1261                         }
1262                 }
1263                 else
1264                 {
1265                         LOG_ERROR("fail to parse parameter of RUNTEST, %d out of %d is parsed", i, num_of_argu);
1266                         return ERROR_FAIL;
1267                 }
1268                 break;
1269         case STATE:
1270                 // STATE [pathstate1 [pathstate2 ...[pathstaten]]] stable_state
1271                 if (num_of_argu < 2)
1272                 {
1273                         LOG_ERROR("invalid parameter of %s", argus[0]);
1274                         return ERROR_FAIL;
1275                 }
1276                 if (num_of_argu > 2)
1277                 {
1278                         // STATE pathstate1 ... stable_state
1279                         path = (tap_state_t *)malloc((num_of_argu - 1) * sizeof(tap_state_t));
1280                         if (NULL == path)
1281                         {
1282                                 LOG_ERROR("not enough memory");
1283                                 return ERROR_FAIL;
1284                         }
1285                         num_of_argu--;          // num of path
1286                         i_tmp = 1;                      // path is from patameter 1
1287                         for (i = 0; i < num_of_argu; i++)
1288                         {
1289                                 path[i] = svf_find_string_in_array(argus[i_tmp++], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1290                                 if (!svf_tap_state_is_valid(path[i]))
1291                                 {
1292                                         LOG_ERROR("%s is not valid state", svf_tap_state_name[path[i]]);
1293                                         return ERROR_FAIL;
1294                                 }
1295                                 if (TAP_RESET == path[i])
1296                                 {
1297                                         if (i > 0)
1298                                         {
1299                                                 jtag_add_pathmove(i, path);
1300                                         }
1301                                         jtag_add_tlr();
1302                                         num_of_argu -= i + 1;
1303                                         i = -1;
1304                                 }
1305                         }
1306                         if (num_of_argu > 0)
1307                         {
1308                                 // execute last path if necessary
1309                                 if (svf_tap_state_is_stable(path[num_of_argu - 1]))
1310                                 {
1311                                         // last state MUST be stable state
1312                                         // TODO: call path_move
1313                                         jtag_add_pathmove(num_of_argu, path);
1314                                         last_state = path[num_of_argu - 1];
1315                                         LOG_DEBUG("\tmove to %s by path_move", svf_tap_state_name[path[num_of_argu - 1]]);
1316                                 }
1317                                 else
1318                                 {
1319                                         LOG_ERROR("%s is not valid state", svf_tap_state_name[path[num_of_argu - 1]]);
1320                                         return ERROR_FAIL;
1321                                 }
1322                         }
1323                         // no need to keep this memory, in jtag_add_pathmove, path will be duplicated
1324                         if (NULL != path)
1325                         {
1326                                 free(path);
1327                                 path = NULL;
1328                         }
1329                 }
1330                 else
1331                 {
1332                         // STATE stable_state
1333                         state = svf_find_string_in_array(argus[1], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1334                         if (svf_tap_state_is_stable(state))
1335                         {
1336                                 // TODO: move to state
1337                                 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1338
1339                                 jtag_queue_command(cmd);
1340
1341                                 cmd->type = JTAG_STATEMOVE;
1342                                 cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1343                                 cmd->cmd.statemove->end_state = state;
1344
1345                                 cmd_queue_end_state = cmd_queue_cur_state = cmd->cmd.statemove->end_state;
1346                                 last_state = state;
1347
1348                                 LOG_DEBUG("\tmove to %s by state_move", svf_tap_state_name[state]);
1349                         }
1350                         else
1351                         {
1352                                 LOG_ERROR("%s is not valid state", svf_tap_state_name[state]);
1353                                 return ERROR_FAIL;
1354                         }
1355                 }
1356                 break;
1357         case TRST:
1358                 // TRST trst_mode
1359                 if (num_of_argu != 2)
1360                 {
1361                         LOG_ERROR("invalid parameter of %s", argus[0]);
1362                         return ERROR_FAIL;
1363                 }
1364                 if (svf_para.trst_mode != TRST_ABSENT)
1365                 {
1366                         if (ERROR_OK != svf_execute_tap())
1367                         {
1368                                 return ERROR_FAIL;
1369                         }
1370                         i_tmp = svf_find_string_in_array(argus[1], (char **)svf_trst_mode_name, dimof(svf_trst_mode_name));
1371                         switch (i_tmp)
1372                         {
1373                         case TRST_ON:
1374                                 last_state = TAP_RESET;
1375                                 jtag_add_reset(1, 0);
1376                                 break;
1377                         case TRST_Z:
1378                         case TRST_OFF:
1379                                 jtag_add_reset(0, 0);
1380                                 break;
1381                         case TRST_ABSENT:
1382                                 break;
1383                         default:
1384                                 LOG_ERROR("unknown TRST mode: %s", argus[1]);
1385                                 return ERROR_FAIL;
1386                         }
1387                         svf_para.trst_mode = i_tmp;
1388                         LOG_DEBUG("\ttrst_mode = %s", svf_trst_mode_name[svf_para.trst_mode]);
1389                 }
1390                 else
1391                 {
1392                         LOG_ERROR("can not accpet TRST command if trst_mode is ABSENT");
1393                         return ERROR_FAIL;
1394                 }
1395                 break;
1396         default:
1397                 LOG_ERROR("invalid svf command: %s", argus[0]);
1398                 return ERROR_FAIL;
1399                 break;
1400         }
1401
1402         if (debug_level >= LOG_LVL_DEBUG)
1403         {
1404                 // for convenient debugging, execute tap if possible
1405                 if ((svf_buffer_index > 0) && \
1406                         (((command != STATE) && (command != RUNTEST)) || \
1407                         ((command == STATE) && (num_of_argu == 2))))
1408                 {
1409                         if (ERROR_OK != svf_execute_tap())
1410                         {
1411                                 return ERROR_FAIL;
1412                         }
1413
1414                         // output debug info
1415                         if ((SIR == command) || (SDR == command))
1416                         {
1417                                 int read_value;
1418                                 memcpy(&read_value, svf_tdi_buffer, sizeof(int));
1419                                 // in debug mode, data is from index 0
1420                                 int read_mask = svf_get_mask_u32(svf_check_tdo_para[0].bit_len);
1421                                 LOG_DEBUG("\tTDO read = 0x%X", read_value & read_mask);
1422                         }
1423                 }
1424         }
1425         else
1426         {
1427                 // for fast executing, execute tap if necessary
1428                 // half of the buffer is for the next command
1429                 if (((svf_buffer_index >= SVF_MAX_BUFFER_SIZE_TO_COMMIT) || (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE / 2)) && \
1430                         (((command != STATE) && (command != RUNTEST)) || \
1431                         ((command == STATE) && (num_of_argu == 2))))
1432                 {
1433                         return svf_execute_tap();
1434                 }
1435         }
1436
1437         return ERROR_OK;
1438 }