1 /***************************************************************************
2 * Copyright (C) 2009 by Simon Qian *
3 * SimonQian@SimonQian.com *
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. *
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. *
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 ***************************************************************************/
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".
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".
40 #include "time_support.h"
71 const char *svf_command_name[14] =
97 const char *svf_trst_mode_name[4] =
105 char *svf_tap_state_name[TAP_NUM_STATES];
107 #define XXR_TDI (1 << 0)
108 #define XXR_TDO (1 << 1)
109 #define XXR_MASK (1 << 2)
110 #define XXR_SMASK (1 << 3)
124 tap_state_t ir_end_state;
125 tap_state_t dr_end_state;
126 tap_state_t runtest_run_state;
127 tap_state_t runtest_end_state;
128 trst_mode_t trst_mode;
130 svf_xxr_para_t hir_para;
131 svf_xxr_para_t hdr_para;
132 svf_xxr_para_t tir_para;
133 svf_xxr_para_t tdr_para;
134 svf_xxr_para_t sir_para;
135 svf_xxr_para_t sdr_para;
139 const svf_para_t svf_para_init =
141 // frequency, ir_end_state, dr_end_state, runtest_run_state, runtest_end_state, trst_mode
142 0, TAP_IDLE, TAP_IDLE, TAP_IDLE, TAP_IDLE, TRST_Z,
144 // {len, data_mask, tdi, tdo, mask, smask},
145 {0, 0, NULL, NULL, NULL, NULL},
147 // {len, data_mask, tdi, tdo, mask, smask},
148 {0, 0, NULL, NULL, NULL, NULL},
150 // {len, data_mask, tdi, tdo, mask, smask},
151 {0, 0, NULL, NULL, NULL, NULL},
153 // {len, data_mask, tdi, tdo, mask, smask},
154 {0, 0, NULL, NULL, NULL, NULL},
156 // {len, data_mask, tdi, tdo, mask, smask},
157 {0, 0, NULL, NULL, NULL, NULL},
159 // {len, data_mask, tdi, tdo, mask, smask},
160 {0, 0, NULL, NULL, NULL, NULL},
165 int line_num; // used to record line number of the check operation
166 // so more information could be printed
167 int enabled; // check is enabled or not
168 int buffer_offset; // buffer_offset to buffers
169 int bit_len; // bit length to check
170 }svf_check_tdo_para_t;
172 #define SVF_CHECK_TDO_PARA_SIZE 1024
173 static svf_check_tdo_para_t *svf_check_tdo_para = NULL;
174 static int svf_check_tdo_para_index = 0;
176 #define dimof(a) (sizeof(a) / sizeof((a)[0]))
178 static int svf_read_command_from_file(int fd);
179 static int svf_check_tdo(void);
180 static int svf_add_check_para(u8 enabled, int buffer_offset, int bit_len);
181 static int svf_run_command(struct command_context_s *cmd_ctx, char *cmd_str);
182 static int handle_svf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
184 static int svf_fd = 0;
185 static char *svf_command_buffer = NULL;
186 static int svf_command_buffer_size = 0;
187 static int svf_line_number = 1;
189 static jtag_tap_t *tap = NULL;
190 static tap_state_t last_state = TAP_RESET;
192 #define SVF_MAX_BUFFER_SIZE_TO_COMMIT (4 * 1024)
193 static u8 *svf_tdi_buffer = NULL, *svf_tdo_buffer = NULL, *svf_mask_buffer = NULL;
194 static int svf_buffer_index = 0, svf_buffer_size = 0;
195 static int svf_quiet = 0;
198 int svf_register_commands(struct command_context_s *cmd_ctx)
200 register_command(cmd_ctx, NULL, "svf", handle_svf_command,
201 COMMAND_EXEC, "run svf <file>");
206 void svf_free_xxd_para(svf_xxr_para_t *para)
210 if (para->tdi != NULL)
215 if (para->tdo != NULL)
220 if (para->mask != NULL)
225 if (para->smask != NULL)
233 static int handle_svf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
235 #define SVF_NUM_OF_OPTIONS 1
236 int command_num = 0, i;
240 if ((argc < 1) || (argc > (1 + SVF_NUM_OF_OPTIONS)))
242 command_print(cmd_ctx, "usage: svf <file> [quiet]");
248 for (i = 1; i < argc; i++)
250 if (!strcmp(args[i], "quiet"))
256 LOG_ERROR("unknown variant for svf: %s", args[i]);
258 // no need to free anything now
263 if ((svf_fd = open(args[0], O_RDONLY)) < 0)
265 command_print(cmd_ctx, "file \"%s\" not found", args[0]);
267 // no need to free anything now
271 LOG_USER("svf processing file: \"%s\"", args[0]);
274 time_ago = timeval_ms();
278 svf_command_buffer_size = 0;
280 svf_check_tdo_para_index = 0;
281 svf_check_tdo_para = malloc(sizeof(svf_check_tdo_para_t) * SVF_CHECK_TDO_PARA_SIZE);
282 if (NULL == svf_check_tdo_para)
284 LOG_ERROR("not enough memory");
289 svf_buffer_index = 0;
290 // double the buffer size
291 // in case current command cannot be commited, and next command is a bit scan command
292 // here is 32K bits for this big scan command, it should be enough
293 // buffer will be reallocated if buffer size is not enough
294 svf_tdi_buffer = (u8 *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
295 if (NULL == svf_tdi_buffer)
297 LOG_ERROR("not enough memory");
301 svf_tdo_buffer = (u8 *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
302 if (NULL == svf_tdo_buffer)
304 LOG_ERROR("not enough memory");
308 svf_mask_buffer = (u8 *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
309 if (NULL == svf_mask_buffer)
311 LOG_ERROR("not enough memory");
315 svf_buffer_size = 2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT;
317 memcpy(&svf_para, &svf_para_init, sizeof(svf_para));
318 for (i = 0; i < (int)dimof(svf_tap_state_name); i++)
320 svf_tap_state_name[i] = (char *)tap_state_name(i);
325 while ( ERROR_OK == svf_read_command_from_file(svf_fd) )
327 if (ERROR_OK != svf_run_command(cmd_ctx, svf_command_buffer))
329 LOG_ERROR("fail to run command at line %d", svf_line_number);
335 if (ERROR_OK != jtag_execute_queue())
339 else if (ERROR_OK != svf_check_tdo())
345 command_print(cmd_ctx, "%d ms used", timeval_ms() - time_ago);
353 if (svf_command_buffer)
355 free(svf_command_buffer);
356 svf_command_buffer = NULL;
357 svf_command_buffer_size = 0;
359 if (svf_check_tdo_para)
361 free(svf_check_tdo_para);
362 svf_check_tdo_para = NULL;
363 svf_check_tdo_para_index = 0;
367 free(svf_tdi_buffer);
368 svf_tdi_buffer = NULL;
372 free(svf_tdo_buffer);
373 svf_tdo_buffer = NULL;
377 free(svf_mask_buffer);
378 svf_mask_buffer = NULL;
380 svf_buffer_index = 0;
383 svf_free_xxd_para(&svf_para.hdr_para);
384 svf_free_xxd_para(&svf_para.hir_para);
385 svf_free_xxd_para(&svf_para.tdr_para);
386 svf_free_xxd_para(&svf_para.tir_para);
387 svf_free_xxd_para(&svf_para.sdr_para);
388 svf_free_xxd_para(&svf_para.sir_para);
392 command_print(cmd_ctx, "svf file programmed successfully for %d commands", command_num);
396 command_print(cmd_ctx, "svf file programmed failed");
402 #define SVFP_CMD_INC_CNT 1024
403 static int svf_read_command_from_file(int fd)
405 char ch, *tmp_buffer = NULL;
406 int cmd_pos = 0, cmd_ok = 0, slash = 0, comment = 0;
408 while (!cmd_ok && (read(fd, &ch, 1) > 0) )
438 if (cmd_pos >= svf_command_buffer_size - 1)
440 tmp_buffer = (char*)malloc(svf_command_buffer_size + SVFP_CMD_INC_CNT); // 1 more byte for '\0'
441 if (NULL == tmp_buffer)
443 LOG_ERROR("not enough memory");
446 if (svf_command_buffer_size > 0)
448 memcpy(tmp_buffer, svf_command_buffer, svf_command_buffer_size);
450 if (svf_command_buffer != NULL)
452 free(svf_command_buffer);
454 svf_command_buffer = tmp_buffer;
455 svf_command_buffer_size += SVFP_CMD_INC_CNT;
458 svf_command_buffer[cmd_pos++] = (char)toupper(ch);
466 svf_command_buffer[cmd_pos] = '\0';
475 static int svf_parse_cmd_string(char *str, int len, char **argus, int *num_of_argu)
477 int pos = 0, num = 0, space_found = 1;
487 LOG_ERROR("fail to parse svf command");
497 argus[num++] = &str[pos];
510 static int svf_tap_state_is_stable(tap_state_t state)
512 return ((TAP_RESET == state) || (TAP_IDLE == state) || (TAP_DRPAUSE == state) || (TAP_IRPAUSE == state));
515 static int svf_tap_state_is_valid(tap_state_t state)
517 return state >= 0 && state < TAP_NUM_STATES;
520 static int svf_find_string_in_array(char *str, char **strs, int num_of_element)
524 for (i = 0; i < num_of_element; i++)
526 if (!strcmp(str, strs[i]))
534 static int svf_adjust_array_length(u8 **arr, int orig_bit_len, int new_bit_len)
536 int new_byte_len = (new_bit_len + 7) >> 3;
538 if ((NULL == *arr) || (((orig_bit_len + 7) >> 3) < ((new_bit_len + 7) >> 3)))
545 *arr = (u8*)malloc(new_byte_len);
548 LOG_ERROR("not enough memory");
551 memset(*arr, 0, new_byte_len);
556 static int svf_copy_hexstring_to_binary(char *str, u8 **bin, int orig_bit_len, int bit_len)
558 int i, str_len = strlen(str), str_byte_len = (bit_len + 3) >> 2, loop_cnt;
559 u8 ch, need_write = 1;
561 if (ERROR_OK != svf_adjust_array_length(bin, orig_bit_len, bit_len))
563 LOG_ERROR("fail to adjust length of array");
567 if (str_byte_len > str_len)
569 loop_cnt = str_byte_len;
576 for (i = 0; i < loop_cnt; i++)
580 ch = str[str_len - i - 1];
581 if ((ch >= '0') && (ch <= '9'))
585 else if ((ch >= 'A') && (ch <= 'F'))
591 LOG_ERROR("invalid hex string");
601 if (i >= str_byte_len)
603 // all data written, other data should be all '0's and needn't to be written
607 LOG_ERROR("value execede length");
611 else if (i == (str_byte_len - 1))
613 // last data byte, written if valid
614 if ((ch & ~((1 << (bit_len - 4 * i)) - 1)) != 0)
616 LOG_ERROR("value execede length");
627 (*bin)[i / 2] |= ch << 4;
641 static int svf_check_tdo(void)
643 int i, j, byte_len, index;
645 for (i = 0; i < svf_check_tdo_para_index; i++)
647 if (svf_check_tdo_para[i].enabled)
649 byte_len = (svf_check_tdo_para[i].bit_len + 7) >> 3;
650 index = svf_check_tdo_para[i].buffer_offset;
651 for (j = 0; j < byte_len; j++)
653 if ((svf_tdi_buffer[index + j] & svf_mask_buffer[index + j]) != svf_tdo_buffer[index + j])
655 unsigned bitmask = (1 << svf_check_tdo_para[i].bit_len) - 1;
656 unsigned received, expected, tapmask;
657 memcpy(&received, svf_tdi_buffer + index, sizeof(unsigned));
658 memcpy(&expected, svf_tdo_buffer + index, sizeof(unsigned));
659 memcpy(&tapmask, svf_mask_buffer + index, sizeof(unsigned));
660 LOG_ERROR("tdo check error at line %d, "
661 "read = 0x%X, want = 0x%X, mask = 0x%X",
662 svf_check_tdo_para[i].line_num,
671 svf_check_tdo_para_index = 0;
676 static int svf_add_check_para(u8 enabled, int buffer_offset, int bit_len)
678 if (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE)
680 LOG_ERROR("toooooo many operation undone");
684 svf_check_tdo_para[svf_check_tdo_para_index].line_num = svf_line_number;
685 svf_check_tdo_para[svf_check_tdo_para_index].bit_len = bit_len;
686 svf_check_tdo_para[svf_check_tdo_para_index].enabled = enabled;
687 svf_check_tdo_para[svf_check_tdo_para_index].buffer_offset = buffer_offset;
688 svf_check_tdo_para_index++;
693 static int svf_execute_tap(void)
695 if (ERROR_OK != jtag_execute_queue())
699 else if (ERROR_OK != svf_check_tdo())
704 svf_buffer_index = 0;
709 // not good to use this
710 extern jtag_command_t** jtag_get_last_command_p(void);
711 extern void* cmd_queue_alloc(size_t size);
712 extern jtag_command_t **last_comand_pointer;
714 static int svf_run_command(struct command_context_s *cmd_ctx, char *cmd_str)
716 char *argus[256], command;
717 int num_of_argu = 0, i;
722 // not good to use this
723 jtag_command_t **last_cmd;
727 float min_time, max_time;
729 svf_xxr_para_t *xxr_para_tmp;
733 tap_state_t *path = NULL, state;
737 LOG_USER("%s", svf_command_buffer);
740 if (ERROR_OK != svf_parse_cmd_string(cmd_str, strlen(cmd_str), argus, &num_of_argu))
745 command = svf_find_string_in_array(argus[0], (char **)svf_command_name, dimof(svf_command_name));
750 if (num_of_argu != 2)
752 LOG_ERROR("invalid parameter of %s", argus[0]);
755 i_tmp = svf_find_string_in_array(argus[1], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
756 if (svf_tap_state_is_stable(i_tmp))
758 if (command == ENDIR)
760 svf_para.ir_end_state = i_tmp;
761 LOG_DEBUG("\tir_end_state = %s", svf_tap_state_name[svf_para.ir_end_state]);
765 svf_para.dr_end_state = i_tmp;
766 LOG_DEBUG("\tdr_end_state = %s", svf_tap_state_name[svf_para.dr_end_state]);
771 LOG_ERROR("%s is not valid state", argus[1]);
776 if ((num_of_argu != 1) && (num_of_argu != 3))
778 LOG_ERROR("invalid parameter of %s", argus[0]);
781 if (1 == num_of_argu)
783 // TODO: set jtag speed to full speed
784 svf_para.frequency = 0;
788 if (strcmp(argus[2], "HZ"))
790 LOG_ERROR("HZ not found in FREQUENCY command");
793 if (ERROR_OK != svf_execute_tap())
797 svf_para.frequency = atof(argus[1]);
798 // TODO: set jtag speed to
799 if (svf_para.frequency > 0)
801 command_run_linef(cmd_ctx, "jtag_khz %d", (int)svf_para.frequency / 1000);
802 LOG_DEBUG("\tfrequency = %f", svf_para.frequency);
807 xxr_para_tmp = &svf_para.hdr_para;
810 xxr_para_tmp = &svf_para.hir_para;
813 xxr_para_tmp = &svf_para.tdr_para;
816 xxr_para_tmp = &svf_para.tir_para;
819 xxr_para_tmp = &svf_para.sdr_para;
822 xxr_para_tmp = &svf_para.sir_para;
825 // XXR length [TDI (tdi)] [TDO (tdo)][MASK (mask)] [SMASK (smask)]
826 if ((num_of_argu > 10) || (num_of_argu % 2))
828 LOG_ERROR("invalid parameter of %s", argus[0]);
831 i_tmp = xxr_para_tmp->len;
832 xxr_para_tmp->len = atoi(argus[1]);
833 LOG_DEBUG("\tlength = %d", xxr_para_tmp->len);
834 xxr_para_tmp->data_mask = 0;
835 for (i = 2; i < num_of_argu; i += 2)
837 if ((strlen(argus[i + 1]) < 3) || (argus[i + 1][0] != '(') || (argus[i + 1][strlen(argus[i + 1]) - 1] != ')'))
839 LOG_ERROR("data section error");
842 argus[i + 1][strlen(argus[i + 1]) - 1] = '\0';
843 // TDI, TDO, MASK, SMASK
844 if (!strcmp(argus[i], "TDI"))
847 pbuffer_tmp = &xxr_para_tmp->tdi;
848 xxr_para_tmp->data_mask |= XXR_TDI;
850 else if (!strcmp(argus[i], "TDO"))
853 pbuffer_tmp = &xxr_para_tmp->tdo;
854 xxr_para_tmp->data_mask |= XXR_TDO;
856 else if (!strcmp(argus[i], "MASK"))
859 pbuffer_tmp = &xxr_para_tmp->mask;
860 xxr_para_tmp->data_mask |= XXR_MASK;
862 else if (!strcmp(argus[i], "SMASK"))
865 pbuffer_tmp = &xxr_para_tmp->smask;
866 xxr_para_tmp->data_mask |= XXR_SMASK;
870 LOG_ERROR("unknow parameter: %s", argus[i]);
873 if (ERROR_OK != svf_copy_hexstring_to_binary(&argus[i + 1][1], pbuffer_tmp, i_tmp, xxr_para_tmp->len))
875 LOG_ERROR("fail to parse hex value");
878 LOG_DEBUG("\t%s = 0x%X", argus[i], (**(int**)pbuffer_tmp) & ((1 << (xxr_para_tmp->len)) - 1));
880 // If a command changes the length of the last scan of the same type and the MASK parameter is absent,
881 // the mask pattern used is all cares
882 if (!(xxr_para_tmp->data_mask & XXR_MASK) && (i_tmp != xxr_para_tmp->len))
884 // MASK not defined and length changed
885 if (ERROR_OK != svf_adjust_array_length(&xxr_para_tmp->mask, i_tmp, xxr_para_tmp->len))
887 LOG_ERROR("fail to adjust length of array");
890 buf_set_ones(xxr_para_tmp->mask, xxr_para_tmp->len);
892 // do scan if necessary
895 // check buffer size first, reallocate if necessary
896 i = svf_para.hdr_para.len + svf_para.sdr_para.len + svf_para.tdr_para.len;
897 if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3))
900 // simply print error message
901 LOG_ERROR("buffer is not enough, report to author");
907 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
908 if (NULL == buffer_tmp)
910 LOG_ERROR("not enough memory");
913 memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
914 // svf_tdi_buffer isn't NULL here
915 free(svf_tdi_buffer);
916 svf_tdi_buffer = buffer_tmp;
918 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
919 if (NULL == buffer_tmp)
921 LOG_ERROR("not enough memory");
924 memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
925 // svf_tdo_buffer isn't NULL here
926 free(svf_tdo_buffer);
927 svf_tdo_buffer = buffer_tmp;
929 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
930 if (NULL == buffer_tmp)
932 LOG_ERROR("not enough memory");
935 memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
936 // svf_mask_buffer isn't NULL here
937 free(svf_mask_buffer);
938 svf_mask_buffer = buffer_tmp;
941 svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
947 buf_set_buf(svf_para.hdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
948 i += svf_para.hdr_para.len;
949 buf_set_buf(svf_para.sdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
950 i += svf_para.sdr_para.len;
951 buf_set_buf(svf_para.tdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
952 i += svf_para.tdr_para.len;
955 if (svf_para.sdr_para.data_mask & XXR_TDO)
957 // assemble dr mask data
959 buf_set_buf(svf_para.hdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
960 i += svf_para.hdr_para.len;
961 buf_set_buf(svf_para.sdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
962 i += svf_para.sdr_para.len;
963 buf_set_buf(svf_para.tdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
964 i += svf_para.tdr_para.len;
965 // assemble dr check data
967 buf_set_buf(svf_para.hdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
968 i += svf_para.hdr_para.len;
969 buf_set_buf(svf_para.sdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
970 i += svf_para.sdr_para.len;
971 buf_set_buf(svf_para.tdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
972 i += svf_para.tdr_para.len;
974 svf_add_check_para(1, svf_buffer_index, i);
978 svf_add_check_para(0, svf_buffer_index, i);
982 field.out_value = &svf_tdi_buffer[svf_buffer_index];
984 field.in_value = &svf_tdi_buffer[svf_buffer_index];
989 jtag_add_plain_dr_scan(1, &field, svf_para.dr_end_state);
991 svf_buffer_index += (i + 7) >> 3;
992 last_state = svf_para.dr_end_state;
994 else if (SIR == command)
996 // check buffer size first, reallocate if necessary
997 i = svf_para.hir_para.len + svf_para.sir_para.len + svf_para.tir_para.len;
998 if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3))
1001 // simply print error message
1002 LOG_ERROR("buffer is not enough, report to author");
1007 // reallocate buffer
1008 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
1009 if (NULL == buffer_tmp)
1011 LOG_ERROR("not enough memory");
1014 memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
1015 // svf_tdi_buffer isn't NULL here
1016 free(svf_tdi_buffer);
1017 svf_tdi_buffer = buffer_tmp;
1019 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
1020 if (NULL == buffer_tmp)
1022 LOG_ERROR("not enough memory");
1025 memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
1026 // svf_tdo_buffer isn't NULL here
1027 free(svf_tdo_buffer);
1028 svf_tdo_buffer = buffer_tmp;
1030 buffer_tmp = (u8 *)malloc(svf_buffer_index + ((i + 7) >> 3));
1031 if (NULL == buffer_tmp)
1033 LOG_ERROR("not enough memory");
1036 memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
1037 // svf_mask_buffer isn't NULL here
1038 free(svf_mask_buffer);
1039 svf_mask_buffer = buffer_tmp;
1042 svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
1048 buf_set_buf(svf_para.hir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1049 i += svf_para.hir_para.len;
1050 buf_set_buf(svf_para.sir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1051 i += svf_para.sir_para.len;
1052 buf_set_buf(svf_para.tir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1053 i += svf_para.tir_para.len;
1056 if (svf_para.sir_para.data_mask & XXR_TDO)
1058 // assemble dr mask data
1060 buf_set_buf(svf_para.hir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1061 i += svf_para.hir_para.len;
1062 buf_set_buf(svf_para.sir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1063 i += svf_para.sir_para.len;
1064 buf_set_buf(svf_para.tir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1065 i += svf_para.tir_para.len;
1066 // assemble dr check data
1068 buf_set_buf(svf_para.hir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1069 i += svf_para.hir_para.len;
1070 buf_set_buf(svf_para.sir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1071 i += svf_para.sir_para.len;
1072 buf_set_buf(svf_para.tir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1073 i += svf_para.tir_para.len;
1075 svf_add_check_para(1, svf_buffer_index, i);
1079 svf_add_check_para(0, svf_buffer_index, i);
1083 field.out_value = &svf_tdi_buffer[svf_buffer_index];
1085 field.in_value = &svf_tdi_buffer[svf_buffer_index];
1090 jtag_add_plain_ir_scan(1, &field, svf_para.ir_end_state);
1092 svf_buffer_index += (i + 7) >> 3;
1093 last_state = svf_para.ir_end_state;
1098 LOG_ERROR("PIO and PIOMAP are not supported");
1102 // RUNTEST [run_state] run_count run_clk [min_time SEC [MAXIMUM max_time SEC]] [ENDSTATE end_state]
1103 // RUNTEST [run_state] min_time SEC [MAXIMUM max_time SEC] [ENDSTATE end_state]
1104 if ((num_of_argu < 3) && (num_of_argu > 11))
1106 LOG_ERROR("invalid parameter of %s", argus[0]);
1115 i_tmp = svf_find_string_in_array(argus[i], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1116 if (svf_tap_state_is_valid(i_tmp))
1118 if (svf_tap_state_is_stable(i_tmp))
1120 svf_para.runtest_run_state = i_tmp;
1122 // When a run_state is specified, the new run_state becomes the default end_state
1123 svf_para.runtest_end_state = i_tmp;
1124 LOG_DEBUG("\trun_state = %s", svf_tap_state_name[svf_para.runtest_run_state]);
1129 LOG_ERROR("%s is not valid state", svf_tap_state_name[i_tmp]);
1133 // run_count run_clk
1134 if (((i + 2) <= num_of_argu) && strcmp(argus[i + 1], "SEC"))
1136 if (!strcmp(argus[i + 1], "TCK"))
1138 // clock source is TCK
1139 run_count = atoi(argus[i]);
1140 LOG_DEBUG("\trun_count@TCK = %d", run_count);
1144 LOG_ERROR("%s not supported for clock", argus[i + 1]);
1150 if (((i + 2) <= num_of_argu) && !strcmp(argus[i + 1], "SEC"))
1152 min_time = atof(argus[i]);
1153 LOG_DEBUG("\tmin_time = %fs", min_time);
1156 // MAXIMUM max_time SEC
1157 if (((i + 3) <= num_of_argu) && !strcmp(argus[i], "MAXIMUM") && !strcmp(argus[i + 2], "SEC"))
1159 max_time = atof(argus[i + 1]);
1160 LOG_DEBUG("\tmax_time = %fs", max_time);
1163 // ENDSTATE end_state
1164 if (((i + 2) <= num_of_argu) && !strcmp(argus[i], "ENDSTATE"))
1166 i_tmp = svf_find_string_in_array(argus[i + 1], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1167 if (svf_tap_state_is_stable(i_tmp))
1169 svf_para.runtest_end_state = i_tmp;
1170 LOG_DEBUG("\tend_state = %s", svf_tap_state_name[svf_para.runtest_end_state]);
1174 LOG_ERROR("%s is not valid state", svf_tap_state_name[i_tmp]);
1179 // calculate run_count
1180 if ((0 == run_count) && (min_time > 0))
1182 run_count = min_time * svf_para.frequency;
1184 // all parameter should be parsed
1185 if (i == num_of_argu)
1189 // run_state and end_state is checked to be stable state
1192 // enter into run_state if necessary
1193 if (last_state != svf_para.runtest_run_state)
1195 last_cmd = jtag_get_last_command_p();
1196 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1197 last_comand_pointer = &((*last_cmd)->next);
1198 (*last_cmd)->next = NULL;
1199 (*last_cmd)->type = JTAG_STATEMOVE;
1200 (*last_cmd)->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1201 (*last_cmd)->cmd.statemove->end_state = svf_para.runtest_run_state;
1203 cmd_queue_end_state = cmd_queue_cur_state = (*last_cmd)->cmd.statemove->end_state;
1206 // call jtag_add_clocks
1207 jtag_add_clocks(run_count);
1209 if (svf_para.runtest_end_state != svf_para.runtest_run_state)
1211 // move to end_state
1212 last_cmd = jtag_get_last_command_p();
1213 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1214 last_comand_pointer = &((*last_cmd)->next);
1215 (*last_cmd)->next = NULL;
1216 (*last_cmd)->type = JTAG_STATEMOVE;
1217 (*last_cmd)->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1218 (*last_cmd)->cmd.statemove->end_state = svf_para.runtest_end_state;
1220 cmd_queue_end_state = cmd_queue_cur_state = (*last_cmd)->cmd.statemove->end_state;
1222 last_state = svf_para.runtest_end_state;
1224 if (svf_para.runtest_run_state != TAP_IDLE)
1226 // RUNTEST can only executed in TAP_IDLE
1227 LOG_ERROR("cannot runtest in %s state", svf_tap_state_name[svf_para.runtest_run_state]);
1231 jtag_add_runtest(run_count, svf_para.runtest_end_state);
1237 LOG_ERROR("fail to parse parameter of RUNTEST, %d out of %d is parsed", i, num_of_argu);
1242 // STATE [pathstate1 [pathstate2 ...[pathstaten]]] stable_state
1243 if (num_of_argu < 2)
1245 LOG_ERROR("invalid parameter of %s", argus[0]);
1248 if (num_of_argu > 2)
1250 // STATE pathstate1 ... stable_state
1251 path = (tap_state_t *)malloc((num_of_argu - 1) * sizeof(tap_state_t));
1254 LOG_ERROR("not enough memory");
1257 num_of_argu--; // num of path
1258 i_tmp = 1; // path is from patameter 1
1259 for (i = 0; i < num_of_argu; i++)
1261 path[i] = svf_find_string_in_array(argus[i_tmp++], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1262 if (!svf_tap_state_is_valid(path[i]))
1264 LOG_ERROR("%s is not valid state", svf_tap_state_name[path[i]]);
1267 if (TAP_RESET == path[i])
1271 jtag_add_pathmove(i, path);
1274 num_of_argu -= i + 1;
1278 if (num_of_argu > 0)
1280 // execute last path if necessary
1281 if (svf_tap_state_is_stable(path[num_of_argu - 1]))
1283 // last state MUST be stable state
1284 // TODO: call path_move
1285 jtag_add_pathmove(num_of_argu, path);
1286 last_state = path[num_of_argu - 1];
1287 LOG_DEBUG("\tmove to %s by path_move", svf_tap_state_name[path[num_of_argu - 1]]);
1291 LOG_ERROR("%s is not valid state", svf_tap_state_name[path[num_of_argu - 1]]);
1295 // no need to keep this memory, in jtag_add_pathmove, path will be duplicated
1304 // STATE stable_state
1305 state = svf_find_string_in_array(argus[1], (char **)svf_tap_state_name, dimof(svf_tap_state_name));
1306 if (svf_tap_state_is_stable(state))
1308 // TODO: move to state
1309 last_cmd = jtag_get_last_command_p();
1310 *last_cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1311 last_comand_pointer = &((*last_cmd)->next);
1312 (*last_cmd)->next = NULL;
1313 (*last_cmd)->type = JTAG_STATEMOVE;
1314 (*last_cmd)->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1315 (*last_cmd)->cmd.statemove->end_state = state;
1317 cmd_queue_end_state = cmd_queue_cur_state = (*last_cmd)->cmd.statemove->end_state;
1320 LOG_DEBUG("\tmove to %s by state_move", svf_tap_state_name[state]);
1324 LOG_ERROR("%s is not valid state", svf_tap_state_name[state]);
1331 if (num_of_argu != 2)
1333 LOG_ERROR("invalid parameter of %s", argus[0]);
1336 if (svf_para.trst_mode != TRST_ABSENT)
1338 if (ERROR_OK != svf_execute_tap())
1342 i_tmp = svf_find_string_in_array(argus[1], (char **)svf_trst_mode_name, dimof(svf_trst_mode_name));
1346 last_state = TAP_RESET;
1347 jtag_add_reset(1, 0);
1351 jtag_add_reset(0, 0);
1356 LOG_ERROR("unknown TRST mode: %s", argus[1]);
1359 svf_para.trst_mode = i_tmp;
1360 LOG_DEBUG("\ttrst_mode = %s", svf_trst_mode_name[svf_para.trst_mode]);
1364 LOG_ERROR("can not accpet TRST command if trst_mode is ABSENT");
1369 LOG_ERROR("invalid svf command: %s", argus[0]);
1374 if (debug_level >= LOG_LVL_DEBUG)
1376 // for convenient debugging, execute tap if possible
1377 if ((svf_buffer_index > 0) && \
1378 (((command != STATE) && (command != RUNTEST)) || \
1379 ((command == STATE) && (num_of_argu == 2))))
1381 if (ERROR_OK != svf_execute_tap())
1386 // output debug info
1387 if ((SIR == command) || (SDR == command))
1390 memcpy(&read_value, svf_tdi_buffer, sizeof(int));
1391 // in debug mode, data is from index 0
1392 int read_mask = (1 << (svf_check_tdo_para[0].bit_len)) - 1;
1393 LOG_DEBUG("\tTDO read = 0x%X", read_value & read_mask);
1399 // for fast executing, execute tap if necessary
1400 // half of the buffer is for the next command
1401 if (((svf_buffer_index >= SVF_MAX_BUFFER_SIZE_TO_COMMIT) || (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE / 2)) && \
1402 (((command != STATE) && (command != RUNTEST)) || \
1403 ((command == STATE) && (num_of_argu == 2))))
1405 return svf_execute_tap();