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 along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 /* The specification for SVF is available here:
22 * http://www.asset-intertech.com/support/svf.pdf
23 * Below, this document is refered to as the "SVF spec".
25 * The specification for XSVF is available here:
26 * http://www.xilinx.com/support/documentation/application_notes/xapp503.pdf
27 * Below, this document is refered to as the "XSVF spec".
34 #include <jtag/jtag.h>
36 #include <helper/time_support.h>
58 static const char *svf_command_name[14] =
84 static const char *svf_trst_mode_name[4] =
96 uint32_t num_of_moves;
101 * These paths are from the SVF specification for the STATE command, to be
102 * used when the STATE command only includes the final state. The first
103 * element of the path is the "from" (current) state, and the last one is
104 * the "to" (target) state.
106 * All specified paths are the shortest ones in the JTAG spec, and are thus
107 * not (!!) exact matches for the paths used elsewhere in OpenOCD. Note
108 * that PAUSE-to-PAUSE transitions all go through UPDATE and then CAPTURE,
109 * which has specific effects on the various registers; they are not NOPs.
111 * Paths to RESET are disabled here. As elsewhere in OpenOCD, and in XSVF
112 * and many SVF implementations, we don't want to risk missing that state.
113 * To get to RESET, always we ignore the current state.
115 static const struct svf_statemove svf_statemoves[] =
117 // from to num_of_moves, paths[8]
118 // {TAP_RESET, TAP_RESET, 1, {TAP_RESET}},
119 {TAP_RESET, TAP_IDLE, 2, {TAP_RESET, TAP_IDLE}},
120 {TAP_RESET, TAP_DRPAUSE, 6, {TAP_RESET, TAP_IDLE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DREXIT1, TAP_DRPAUSE}},
121 {TAP_RESET, TAP_IRPAUSE, 7, {TAP_RESET, TAP_IDLE, TAP_DRSELECT, TAP_IRSELECT, TAP_IRCAPTURE, TAP_IREXIT1, TAP_IRPAUSE}},
123 // {TAP_IDLE, TAP_RESET, 4, {TAP_IDLE, TAP_DRSELECT, TAP_IRSELECT, TAP_RESET}},
124 {TAP_IDLE, TAP_IDLE, 1, {TAP_IDLE}},
125 {TAP_IDLE, TAP_DRPAUSE, 5, {TAP_IDLE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DREXIT1, TAP_DRPAUSE}},
126 {TAP_IDLE, TAP_IRPAUSE, 6, {TAP_IDLE, TAP_DRSELECT, TAP_IRSELECT, TAP_IRCAPTURE, TAP_IREXIT1, TAP_IRPAUSE}},
128 // {TAP_DRPAUSE, TAP_RESET, 6, {TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_RESET}},
129 {TAP_DRPAUSE, TAP_IDLE, 4, {TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE, TAP_IDLE}},
130 {TAP_DRPAUSE, TAP_DRPAUSE, 7, {TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DREXIT1, TAP_DRPAUSE}},
131 {TAP_DRPAUSE, TAP_IRPAUSE, 8, {TAP_DRPAUSE, TAP_DREXIT2, TAP_DRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_IRCAPTURE, TAP_IREXIT1, TAP_IRPAUSE}},
133 // {TAP_IRPAUSE, TAP_RESET, 6, {TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_RESET}},
134 {TAP_IRPAUSE, TAP_IDLE, 4, {TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE, TAP_IDLE}},
135 {TAP_IRPAUSE, TAP_DRPAUSE, 7, {TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE, TAP_DRSELECT, TAP_DRCAPTURE, TAP_DREXIT1, TAP_DRPAUSE}},
136 {TAP_IRPAUSE, TAP_IRPAUSE, 8, {TAP_IRPAUSE, TAP_IREXIT2, TAP_IRUPDATE, TAP_DRSELECT, TAP_IRSELECT, TAP_IRCAPTURE, TAP_IREXIT1, TAP_IRPAUSE}}
140 #define XXR_TDI (1 << 0)
141 #define XXR_TDO (1 << 1)
142 #define XXR_MASK (1 << 2)
143 #define XXR_SMASK (1 << 3)
157 tap_state_t ir_end_state;
158 tap_state_t dr_end_state;
159 tap_state_t runtest_run_state;
160 tap_state_t runtest_end_state;
161 trst_mode_t trst_mode;
163 struct svf_xxr_para hir_para;
164 struct svf_xxr_para hdr_para;
165 struct svf_xxr_para tir_para;
166 struct svf_xxr_para tdr_para;
167 struct svf_xxr_para sir_para;
168 struct svf_xxr_para sdr_para;
171 static struct svf_para svf_para;
172 static const struct svf_para svf_para_init =
174 // frequency, ir_end_state, dr_end_state, runtest_run_state, runtest_end_state, trst_mode
175 0, TAP_IDLE, TAP_IDLE, TAP_IDLE, TAP_IDLE, TRST_Z,
177 // {len, data_mask, tdi, tdo, mask, smask},
178 {0, 0, NULL, NULL, NULL, NULL},
180 // {len, data_mask, tdi, tdo, mask, smask},
181 {0, 0, NULL, NULL, NULL, NULL},
183 // {len, data_mask, tdi, tdo, mask, smask},
184 {0, 0, NULL, NULL, NULL, NULL},
186 // {len, data_mask, tdi, tdo, mask, smask},
187 {0, 0, NULL, NULL, NULL, NULL},
189 // {len, data_mask, tdi, tdo, mask, smask},
190 {0, 0, NULL, NULL, NULL, NULL},
192 // {len, data_mask, tdi, tdo, mask, smask},
193 {0, 0, NULL, NULL, NULL, NULL},
196 struct svf_check_tdo_para
198 int line_num; // used to record line number of the check operation
199 // so more information could be printed
200 int enabled; // check is enabled or not
201 int buffer_offset; // buffer_offset to buffers
202 int bit_len; // bit length to check
205 #define SVF_CHECK_TDO_PARA_SIZE 1024
206 static struct svf_check_tdo_para *svf_check_tdo_para = NULL;
207 static int svf_check_tdo_para_index = 0;
209 static int svf_read_command_from_file(int fd);
210 static int svf_check_tdo(void);
211 static int svf_add_check_para(uint8_t enabled, int buffer_offset, int bit_len);
212 static int svf_run_command(struct command_context *cmd_ctx, char *cmd_str);
214 static int svf_fd = 0;
215 static char *svf_command_buffer = NULL;
216 static int svf_command_buffer_size = 0;
217 static int svf_line_number = 1;
219 static struct jtag_tap *tap = NULL;
221 #define SVF_MAX_BUFFER_SIZE_TO_COMMIT (4 * 1024)
222 static uint8_t *svf_tdi_buffer = NULL, *svf_tdo_buffer = NULL, *svf_mask_buffer = NULL;
223 static int svf_buffer_index = 0, svf_buffer_size = 0;
224 static int svf_quiet = 0;
227 static void svf_free_xxd_para(struct svf_xxr_para *para)
231 if (para->tdi != NULL)
236 if (para->tdo != NULL)
241 if (para->mask != NULL)
246 if (para->smask != NULL)
254 static unsigned svf_get_mask_u32(int bitlen)
262 else if (bitlen >= 32)
264 bitmask = 0xFFFFFFFF;
268 bitmask = (1 << bitlen) - 1;
274 int svf_add_statemove(tap_state_t state_to)
276 tap_state_t state_from = cmd_queue_cur_state;
279 /* when resetting, be paranoid and ignore current state */
280 if (state_to == TAP_RESET) {
285 for (index = 0; index < ARRAY_SIZE(svf_statemoves); index++)
287 if ((svf_statemoves[index].from == state_from)
288 && (svf_statemoves[index].to == state_to))
290 /* recorded path includes current state ... avoid extra TCKs! */
291 if (svf_statemoves[index].num_of_moves > 1)
292 jtag_add_pathmove(svf_statemoves[index].num_of_moves - 1,
293 svf_statemoves[index].paths + 1);
295 jtag_add_pathmove(svf_statemoves[index].num_of_moves,
296 svf_statemoves[index].paths);
300 LOG_ERROR("SVF: can not move to %s", tap_state_name(state_to));
304 COMMAND_HANDLER(handle_svf_command)
306 #define SVF_NUM_OF_OPTIONS 1
311 if ((CMD_ARGC < 1) || (CMD_ARGC > (1 + SVF_NUM_OF_OPTIONS)))
313 command_print(CMD_CTX, "usage: svf <file> [quiet]");
319 for (unsigned i = 1; i < CMD_ARGC; i++)
321 if (!strcmp(CMD_ARGV[i], "quiet"))
327 LOG_ERROR("unknown variant for svf: %s", CMD_ARGV[i]);
329 // no need to free anything now
334 if ((svf_fd = open(CMD_ARGV[0], O_RDONLY)) < 0)
336 command_print(CMD_CTX, "file \"%s\" not found", CMD_ARGV[0]);
338 // no need to free anything now
342 LOG_USER("svf processing file: \"%s\"", CMD_ARGV[0]);
345 time_ago = timeval_ms();
349 svf_command_buffer_size = 0;
351 svf_check_tdo_para_index = 0;
352 svf_check_tdo_para = malloc(sizeof(struct svf_check_tdo_para) * SVF_CHECK_TDO_PARA_SIZE);
353 if (NULL == svf_check_tdo_para)
355 LOG_ERROR("not enough memory");
360 svf_buffer_index = 0;
361 // double the buffer size
362 // in case current command cannot be commited, and next command is a bit scan command
363 // here is 32K bits for this big scan command, it should be enough
364 // buffer will be reallocated if buffer size is not enough
365 svf_tdi_buffer = (uint8_t *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
366 if (NULL == svf_tdi_buffer)
368 LOG_ERROR("not enough memory");
372 svf_tdo_buffer = (uint8_t *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
373 if (NULL == svf_tdo_buffer)
375 LOG_ERROR("not enough memory");
379 svf_mask_buffer = (uint8_t *)malloc(2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT);
380 if (NULL == svf_mask_buffer)
382 LOG_ERROR("not enough memory");
386 svf_buffer_size = 2 * SVF_MAX_BUFFER_SIZE_TO_COMMIT;
388 memcpy(&svf_para, &svf_para_init, sizeof(svf_para));
393 while (ERROR_OK == svf_read_command_from_file(svf_fd))
395 if (ERROR_OK != svf_run_command(CMD_CTX, svf_command_buffer))
397 LOG_ERROR("fail to run command at line %d", svf_line_number);
403 if (ERROR_OK != jtag_execute_queue())
407 else if (ERROR_OK != svf_check_tdo())
413 command_print(CMD_CTX, "%lld ms used", timeval_ms() - time_ago);
421 if (svf_command_buffer)
423 free(svf_command_buffer);
424 svf_command_buffer = NULL;
425 svf_command_buffer_size = 0;
427 if (svf_check_tdo_para)
429 free(svf_check_tdo_para);
430 svf_check_tdo_para = NULL;
431 svf_check_tdo_para_index = 0;
435 free(svf_tdi_buffer);
436 svf_tdi_buffer = NULL;
440 free(svf_tdo_buffer);
441 svf_tdo_buffer = NULL;
445 free(svf_mask_buffer);
446 svf_mask_buffer = NULL;
448 svf_buffer_index = 0;
451 svf_free_xxd_para(&svf_para.hdr_para);
452 svf_free_xxd_para(&svf_para.hir_para);
453 svf_free_xxd_para(&svf_para.tdr_para);
454 svf_free_xxd_para(&svf_para.tir_para);
455 svf_free_xxd_para(&svf_para.sdr_para);
456 svf_free_xxd_para(&svf_para.sir_para);
460 command_print(CMD_CTX, "svf file programmed successfully for %d commands", command_num);
464 command_print(CMD_CTX, "svf file programmed failed");
470 #define SVFP_CMD_INC_CNT 1024
471 static int svf_read_command_from_file(int fd)
474 char *tmp_buffer = NULL;
475 int cmd_pos = 0, cmd_ok = 0, slash = 0, comment = 0;
477 while (!cmd_ok && (read(fd, &ch, 1) > 0))
507 if (cmd_pos >= svf_command_buffer_size - 1)
509 tmp_buffer = (char*)malloc(svf_command_buffer_size + SVFP_CMD_INC_CNT); // 1 more byte for '\0'
510 if (NULL == tmp_buffer)
512 LOG_ERROR("not enough memory");
515 if (svf_command_buffer_size > 0)
517 memcpy(tmp_buffer, svf_command_buffer, svf_command_buffer_size);
519 if (svf_command_buffer != NULL)
521 free(svf_command_buffer);
523 svf_command_buffer = tmp_buffer;
524 svf_command_buffer_size += SVFP_CMD_INC_CNT;
527 svf_command_buffer[cmd_pos++] = (char)toupper(ch);
535 svf_command_buffer[cmd_pos] = '\0';
544 static int svf_parse_cmd_string(char *str, int len, char **argus, int *num_of_argu)
546 int pos = 0, num = 0, space_found = 1;
556 LOG_ERROR("fail to parse svf command");
566 argus[num++] = &str[pos];
579 bool svf_tap_state_is_stable(tap_state_t state)
581 return (TAP_RESET == state) || (TAP_IDLE == state)
582 || (TAP_DRPAUSE == state) || (TAP_IRPAUSE == state);
585 static int svf_find_string_in_array(char *str, char **strs, int num_of_element)
589 for (i = 0; i < num_of_element; i++)
591 if (!strcmp(str, strs[i]))
599 static int svf_adjust_array_length(uint8_t **arr, int orig_bit_len, int new_bit_len)
601 int new_byte_len = (new_bit_len + 7) >> 3;
603 if ((NULL == *arr) || (((orig_bit_len + 7) >> 3) < ((new_bit_len + 7) >> 3)))
610 *arr = (uint8_t*)malloc(new_byte_len);
613 LOG_ERROR("not enough memory");
616 memset(*arr, 0, new_byte_len);
621 static int svf_copy_hexstring_to_binary(char *str, uint8_t **bin, int orig_bit_len, int bit_len)
623 int i, str_len = strlen(str), str_hbyte_len = (bit_len + 3) >> 2;
626 if (ERROR_OK != svf_adjust_array_length(bin, orig_bit_len, bit_len))
628 LOG_ERROR("fail to adjust length of array");
632 for (i = 0; i < str_hbyte_len; i++)
641 if ((ch >= '0') && (ch <= '9'))
646 else if ((ch >= 'A') && (ch <= 'F'))
653 LOG_ERROR("invalid hex string");
665 (*bin)[i / 2] |= ch << 4;
675 // consume optional leading '0' characters
676 while (str_len > 0 && str[str_len - 1] == '0')
680 if (str_len > 0 || (ch & ~((2 << ((bit_len - 1) % 4)) - 1)) != 0)
682 LOG_ERROR("value execeeds length");
689 static int svf_check_tdo(void)
693 for (i = 0; i < svf_check_tdo_para_index; i++)
695 index = svf_check_tdo_para[i].buffer_offset;
696 len = svf_check_tdo_para[i].bit_len;
697 if ((svf_check_tdo_para[i].enabled)
698 && buf_cmp_mask(&svf_tdi_buffer[index], &svf_tdo_buffer[index], &svf_mask_buffer[index], len))
701 unsigned received, expected, tapmask;
702 bitmask = svf_get_mask_u32(svf_check_tdo_para[i].bit_len);
704 memcpy(&received, svf_tdi_buffer + index, sizeof(unsigned));
705 memcpy(&expected, svf_tdo_buffer + index, sizeof(unsigned));
706 memcpy(&tapmask, svf_mask_buffer + index, sizeof(unsigned));
707 LOG_ERROR("tdo check error at line %d",
708 svf_check_tdo_para[i].line_num);
709 LOG_ERROR("read = 0x%X, want = 0x%X, mask = 0x%X",
716 svf_check_tdo_para_index = 0;
721 static int svf_add_check_para(uint8_t enabled, int buffer_offset, int bit_len)
723 if (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE)
725 LOG_ERROR("toooooo many operation undone");
729 svf_check_tdo_para[svf_check_tdo_para_index].line_num = svf_line_number;
730 svf_check_tdo_para[svf_check_tdo_para_index].bit_len = bit_len;
731 svf_check_tdo_para[svf_check_tdo_para_index].enabled = enabled;
732 svf_check_tdo_para[svf_check_tdo_para_index].buffer_offset = buffer_offset;
733 svf_check_tdo_para_index++;
738 static int svf_execute_tap(void)
740 if (ERROR_OK != jtag_execute_queue())
744 else if (ERROR_OK != svf_check_tdo())
749 svf_buffer_index = 0;
754 static int svf_run_command(struct command_context *cmd_ctx, char *cmd_str)
756 char *argus[256], command;
757 int num_of_argu = 0, i;
764 float min_time, max_time;
766 struct svf_xxr_para *xxr_para_tmp;
767 uint8_t **pbuffer_tmp;
768 struct scan_field field;
770 tap_state_t *path = NULL, state;
774 LOG_USER("%s", svf_command_buffer);
777 if (ERROR_OK != svf_parse_cmd_string(cmd_str, strlen(cmd_str), argus, &num_of_argu))
782 /* NOTE: we're a bit loose here, because we ignore case in
783 * TAP state names (instead of insisting on uppercase).
786 command = svf_find_string_in_array(argus[0],
787 (char **)svf_command_name, ARRAY_SIZE(svf_command_name));
792 if (num_of_argu != 2)
794 LOG_ERROR("invalid parameter of %s", argus[0]);
798 i_tmp = tap_state_by_name(argus[1]);
800 if (svf_tap_state_is_stable(i_tmp))
802 if (command == ENDIR)
804 svf_para.ir_end_state = i_tmp;
805 LOG_DEBUG("\tIR end_state = %s",
806 tap_state_name(i_tmp));
810 svf_para.dr_end_state = i_tmp;
811 LOG_DEBUG("\tDR end_state = %s",
812 tap_state_name(i_tmp));
817 LOG_ERROR("%s: %s is not a stable state",
823 if ((num_of_argu != 1) && (num_of_argu != 3))
825 LOG_ERROR("invalid parameter of %s", argus[0]);
828 if (1 == num_of_argu)
830 // TODO: set jtag speed to full speed
831 svf_para.frequency = 0;
835 if (strcmp(argus[2], "HZ"))
837 LOG_ERROR("HZ not found in FREQUENCY command");
840 if (ERROR_OK != svf_execute_tap())
844 svf_para.frequency = atof(argus[1]);
845 // TODO: set jtag speed to
846 if (svf_para.frequency > 0)
848 command_run_linef(cmd_ctx, "jtag_khz %d", (int)svf_para.frequency / 1000);
849 LOG_DEBUG("\tfrequency = %f", svf_para.frequency);
854 xxr_para_tmp = &svf_para.hdr_para;
857 xxr_para_tmp = &svf_para.hir_para;
860 xxr_para_tmp = &svf_para.tdr_para;
863 xxr_para_tmp = &svf_para.tir_para;
866 xxr_para_tmp = &svf_para.sdr_para;
869 xxr_para_tmp = &svf_para.sir_para;
872 // XXR length [TDI (tdi)] [TDO (tdo)][MASK (mask)] [SMASK (smask)]
873 if ((num_of_argu > 10) || (num_of_argu % 2))
875 LOG_ERROR("invalid parameter of %s", argus[0]);
878 i_tmp = xxr_para_tmp->len;
879 xxr_para_tmp->len = atoi(argus[1]);
880 LOG_DEBUG("\tlength = %d", xxr_para_tmp->len);
881 xxr_para_tmp->data_mask = 0;
882 for (i = 2; i < num_of_argu; i += 2)
884 if ((strlen(argus[i + 1]) < 3) || (argus[i + 1][0] != '(') || (argus[i + 1][strlen(argus[i + 1]) - 1] != ')'))
886 LOG_ERROR("data section error");
889 argus[i + 1][strlen(argus[i + 1]) - 1] = '\0';
890 // TDI, TDO, MASK, SMASK
891 if (!strcmp(argus[i], "TDI"))
894 pbuffer_tmp = &xxr_para_tmp->tdi;
895 xxr_para_tmp->data_mask |= XXR_TDI;
897 else if (!strcmp(argus[i], "TDO"))
900 pbuffer_tmp = &xxr_para_tmp->tdo;
901 xxr_para_tmp->data_mask |= XXR_TDO;
903 else if (!strcmp(argus[i], "MASK"))
906 pbuffer_tmp = &xxr_para_tmp->mask;
907 xxr_para_tmp->data_mask |= XXR_MASK;
909 else if (!strcmp(argus[i], "SMASK"))
912 pbuffer_tmp = &xxr_para_tmp->smask;
913 xxr_para_tmp->data_mask |= XXR_SMASK;
917 LOG_ERROR("unknow parameter: %s", argus[i]);
920 if (ERROR_OK != svf_copy_hexstring_to_binary(&argus[i + 1][1], pbuffer_tmp, i_tmp, xxr_para_tmp->len))
922 LOG_ERROR("fail to parse hex value");
925 LOG_DEBUG("\t%s = 0x%X", argus[i], (**(int**)pbuffer_tmp) & svf_get_mask_u32(xxr_para_tmp->len));
927 // If a command changes the length of the last scan of the same type and the MASK parameter is absent,
928 // the mask pattern used is all cares
929 if (!(xxr_para_tmp->data_mask & XXR_MASK) && (i_tmp != xxr_para_tmp->len))
931 // MASK not defined and length changed
932 if (ERROR_OK != svf_adjust_array_length(&xxr_para_tmp->mask, i_tmp, xxr_para_tmp->len))
934 LOG_ERROR("fail to adjust length of array");
937 buf_set_ones(xxr_para_tmp->mask, xxr_para_tmp->len);
939 // If TDO is absent, no comparison is needed, set the mask to 0
940 if (!(xxr_para_tmp->data_mask & XXR_TDO))
942 if (NULL == xxr_para_tmp->tdo)
944 if (ERROR_OK != svf_adjust_array_length(&xxr_para_tmp->tdo, i_tmp, xxr_para_tmp->len))
946 LOG_ERROR("fail to adjust length of array");
950 if (NULL == xxr_para_tmp->mask)
952 if (ERROR_OK != svf_adjust_array_length(&xxr_para_tmp->mask, i_tmp, xxr_para_tmp->len))
954 LOG_ERROR("fail to adjust length of array");
958 memset(xxr_para_tmp->mask, 0, (xxr_para_tmp->len + 7) >> 3);
960 // do scan if necessary
963 // check buffer size first, reallocate if necessary
964 i = svf_para.hdr_para.len + svf_para.sdr_para.len + svf_para.tdr_para.len;
965 if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3))
968 // simply print error message
969 LOG_ERROR("buffer is not enough, report to author");
975 buffer_tmp = (uint8_t *)malloc(svf_buffer_index + ((i + 7) >> 3));
976 if (NULL == buffer_tmp)
978 LOG_ERROR("not enough memory");
981 memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
982 // svf_tdi_buffer isn't NULL here
983 free(svf_tdi_buffer);
984 svf_tdi_buffer = buffer_tmp;
986 buffer_tmp = (uint8_t *)malloc(svf_buffer_index + ((i + 7) >> 3));
987 if (NULL == buffer_tmp)
989 LOG_ERROR("not enough memory");
992 memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
993 // svf_tdo_buffer isn't NULL here
994 free(svf_tdo_buffer);
995 svf_tdo_buffer = buffer_tmp;
997 buffer_tmp = (uint8_t *)malloc(svf_buffer_index + ((i + 7) >> 3));
998 if (NULL == buffer_tmp)
1000 LOG_ERROR("not enough memory");
1003 memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
1004 // svf_mask_buffer isn't NULL here
1005 free(svf_mask_buffer);
1006 svf_mask_buffer = buffer_tmp;
1009 svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
1015 buf_set_buf(svf_para.hdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
1016 i += svf_para.hdr_para.len;
1017 buf_set_buf(svf_para.sdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
1018 i += svf_para.sdr_para.len;
1019 buf_set_buf(svf_para.tdr_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
1020 i += svf_para.tdr_para.len;
1023 if (svf_para.sdr_para.data_mask & XXR_TDO)
1025 // assemble dr mask data
1027 buf_set_buf(svf_para.hdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
1028 i += svf_para.hdr_para.len;
1029 buf_set_buf(svf_para.sdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
1030 i += svf_para.sdr_para.len;
1031 buf_set_buf(svf_para.tdr_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
1032 i += svf_para.tdr_para.len;
1033 // assemble dr check data
1035 buf_set_buf(svf_para.hdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.hdr_para.len);
1036 i += svf_para.hdr_para.len;
1037 buf_set_buf(svf_para.sdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.sdr_para.len);
1038 i += svf_para.sdr_para.len;
1039 buf_set_buf(svf_para.tdr_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.tdr_para.len);
1040 i += svf_para.tdr_para.len;
1042 svf_add_check_para(1, svf_buffer_index, i);
1046 svf_add_check_para(0, svf_buffer_index, i);
1050 field.out_value = &svf_tdi_buffer[svf_buffer_index];
1051 field.in_value = &svf_tdi_buffer[svf_buffer_index];
1052 /* NOTE: doesn't use SVF-specified state paths */
1053 jtag_add_plain_dr_scan(1, &field, svf_para.dr_end_state);
1055 svf_buffer_index += (i + 7) >> 3;
1057 else if (SIR == command)
1059 // check buffer size first, reallocate if necessary
1060 i = svf_para.hir_para.len + svf_para.sir_para.len + svf_para.tir_para.len;
1061 if ((svf_buffer_size - svf_buffer_index) < ((i + 7) >> 3))
1064 // simply print error message
1065 LOG_ERROR("buffer is not enough, report to author");
1068 uint8_t *buffer_tmp;
1070 // reallocate buffer
1071 buffer_tmp = (uint8_t *)malloc(svf_buffer_index + ((i + 7) >> 3));
1072 if (NULL == buffer_tmp)
1074 LOG_ERROR("not enough memory");
1077 memcpy(buffer_tmp, svf_tdi_buffer, svf_buffer_index);
1078 // svf_tdi_buffer isn't NULL here
1079 free(svf_tdi_buffer);
1080 svf_tdi_buffer = buffer_tmp;
1082 buffer_tmp = (uint8_t *)malloc(svf_buffer_index + ((i + 7) >> 3));
1083 if (NULL == buffer_tmp)
1085 LOG_ERROR("not enough memory");
1088 memcpy(buffer_tmp, svf_tdo_buffer, svf_buffer_index);
1089 // svf_tdo_buffer isn't NULL here
1090 free(svf_tdo_buffer);
1091 svf_tdo_buffer = buffer_tmp;
1093 buffer_tmp = (uint8_t *)malloc(svf_buffer_index + ((i + 7) >> 3));
1094 if (NULL == buffer_tmp)
1096 LOG_ERROR("not enough memory");
1099 memcpy(buffer_tmp, svf_mask_buffer, svf_buffer_index);
1100 // svf_mask_buffer isn't NULL here
1101 free(svf_mask_buffer);
1102 svf_mask_buffer = buffer_tmp;
1105 svf_buffer_size = svf_buffer_index + ((i + 7) >> 3);
1111 buf_set_buf(svf_para.hir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1112 i += svf_para.hir_para.len;
1113 buf_set_buf(svf_para.sir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1114 i += svf_para.sir_para.len;
1115 buf_set_buf(svf_para.tir_para.tdi, 0, &svf_tdi_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1116 i += svf_para.tir_para.len;
1119 if (svf_para.sir_para.data_mask & XXR_TDO)
1121 // assemble dr mask data
1123 buf_set_buf(svf_para.hir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1124 i += svf_para.hir_para.len;
1125 buf_set_buf(svf_para.sir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1126 i += svf_para.sir_para.len;
1127 buf_set_buf(svf_para.tir_para.mask, 0, &svf_mask_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1128 i += svf_para.tir_para.len;
1129 // assemble dr check data
1131 buf_set_buf(svf_para.hir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.hir_para.len);
1132 i += svf_para.hir_para.len;
1133 buf_set_buf(svf_para.sir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.sir_para.len);
1134 i += svf_para.sir_para.len;
1135 buf_set_buf(svf_para.tir_para.tdo, 0, &svf_tdo_buffer[svf_buffer_index], i, svf_para.tir_para.len);
1136 i += svf_para.tir_para.len;
1138 svf_add_check_para(1, svf_buffer_index, i);
1142 svf_add_check_para(0, svf_buffer_index, i);
1146 field.out_value = &svf_tdi_buffer[svf_buffer_index];
1147 field.in_value = &svf_tdi_buffer[svf_buffer_index];
1148 /* NOTE: doesn't use SVF-specified state paths */
1149 jtag_add_plain_ir_scan(1, &field, svf_para.ir_end_state);
1151 svf_buffer_index += (i + 7) >> 3;
1156 LOG_ERROR("PIO and PIOMAP are not supported");
1160 // RUNTEST [run_state] run_count run_clk [min_time SEC [MAXIMUM max_time SEC]] [ENDSTATE end_state]
1161 // RUNTEST [run_state] min_time SEC [MAXIMUM max_time SEC] [ENDSTATE end_state]
1162 if ((num_of_argu < 3) && (num_of_argu > 11))
1164 LOG_ERROR("invalid parameter of %s", argus[0]);
1174 i_tmp = tap_state_by_name(argus[i]);
1175 if (i_tmp != TAP_INVALID)
1177 if (svf_tap_state_is_stable(i_tmp))
1179 svf_para.runtest_run_state = i_tmp;
1181 /* When a run_state is specified, the new
1182 * run_state becomes the default end_state.
1184 svf_para.runtest_end_state = i_tmp;
1185 LOG_DEBUG("\trun_state = %s",
1186 tap_state_name(i_tmp));
1191 LOG_ERROR("%s: %s is not a stable state",
1192 argus[0], tap_state_name(i_tmp));
1197 // run_count run_clk
1198 if (((i + 2) <= num_of_argu) && strcmp(argus[i + 1], "SEC"))
1200 if (!strcmp(argus[i + 1], "TCK"))
1202 // clock source is TCK
1203 run_count = atoi(argus[i]);
1204 LOG_DEBUG("\trun_count@TCK = %d", run_count);
1208 LOG_ERROR("%s not supported for clock", argus[i + 1]);
1214 if (((i + 2) <= num_of_argu) && !strcmp(argus[i + 1], "SEC"))
1216 min_time = atof(argus[i]);
1217 LOG_DEBUG("\tmin_time = %fs", min_time);
1220 // MAXIMUM max_time SEC
1221 if (((i + 3) <= num_of_argu) && !strcmp(argus[i], "MAXIMUM") && !strcmp(argus[i + 2], "SEC"))
1223 max_time = atof(argus[i + 1]);
1224 LOG_DEBUG("\tmax_time = %fs", max_time);
1227 // ENDSTATE end_state
1228 if (((i + 2) <= num_of_argu) && !strcmp(argus[i], "ENDSTATE"))
1230 i_tmp = tap_state_by_name(argus[i + 1]);
1232 if (svf_tap_state_is_stable(i_tmp))
1234 svf_para.runtest_end_state = i_tmp;
1235 LOG_DEBUG("\tend_state = %s",
1236 tap_state_name(i_tmp));
1240 LOG_ERROR("%s: %s is not a stable state",
1241 argus[0], tap_state_name(i_tmp));
1246 // calculate run_count
1247 if ((0 == run_count) && (min_time > 0))
1249 run_count = min_time * svf_para.frequency;
1251 // all parameter should be parsed
1252 if (i == num_of_argu)
1256 // run_state and end_state is checked to be stable state
1259 /* FIXME handle statemove failures */
1262 // enter into run_state if necessary
1263 if (cmd_queue_cur_state != svf_para.runtest_run_state)
1265 retval = svf_add_statemove(svf_para.runtest_run_state);
1268 // call jtag_add_clocks
1269 jtag_add_clocks(run_count);
1271 // move to end_state if necessary
1272 if (svf_para.runtest_end_state != svf_para.runtest_run_state)
1274 retval = svf_add_statemove(svf_para.runtest_end_state);
1277 if (svf_para.runtest_run_state != TAP_IDLE)
1279 LOG_ERROR("cannot runtest in %s state",
1280 tap_state_name(svf_para.runtest_run_state));
1284 jtag_add_runtest(run_count, svf_para.runtest_end_state);
1290 LOG_ERROR("fail to parse parameter of RUNTEST, %d out of %d is parsed", i, num_of_argu);
1295 // STATE [pathstate1 [pathstate2 ...[pathstaten]]] stable_state
1296 if (num_of_argu < 2)
1298 LOG_ERROR("invalid parameter of %s", argus[0]);
1301 if (num_of_argu > 2)
1303 // STATE pathstate1 ... stable_state
1304 path = (tap_state_t *)malloc((num_of_argu - 1) * sizeof(tap_state_t));
1307 LOG_ERROR("not enough memory");
1310 num_of_argu--; // num of path
1311 i_tmp = 1; /* path is from parameter 1 */
1312 for (i = 0; i < num_of_argu; i++, i_tmp++)
1314 path[i] = tap_state_by_name(argus[i_tmp]);
1315 if (path[i] == TAP_INVALID)
1317 LOG_ERROR("%s: %s is not a valid state",
1318 argus[0], argus[i_tmp]);
1322 /* OpenOCD refuses paths containing TAP_RESET */
1323 if (TAP_RESET == path[i])
1325 /* FIXME last state MUST be stable! */
1328 jtag_add_pathmove(i, path);
1331 num_of_argu -= i + 1;
1335 if (num_of_argu > 0)
1337 // execute last path if necessary
1338 if (svf_tap_state_is_stable(path[num_of_argu - 1]))
1340 // last state MUST be stable state
1341 jtag_add_pathmove(num_of_argu, path);
1342 LOG_DEBUG("\tmove to %s by path_move",
1343 tap_state_name(path[num_of_argu - 1]));
1347 LOG_ERROR("%s: %s is not a stable state",
1349 tap_state_name(path[num_of_argu - 1]));
1360 // STATE stable_state
1361 state = tap_state_by_name(argus[1]);
1362 if (svf_tap_state_is_stable(state))
1364 LOG_DEBUG("\tmove to %s by svf_add_statemove",
1365 tap_state_name(state));
1366 /* FIXME handle statemove failures */
1367 svf_add_statemove(state);
1371 LOG_ERROR("%s: %s is not a stable state",
1372 argus[0], tap_state_name(state));
1379 if (num_of_argu != 2)
1381 LOG_ERROR("invalid parameter of %s", argus[0]);
1384 if (svf_para.trst_mode != TRST_ABSENT)
1386 if (ERROR_OK != svf_execute_tap())
1390 i_tmp = svf_find_string_in_array(argus[1],
1391 (char **)svf_trst_mode_name,
1392 ARRAY_SIZE(svf_trst_mode_name));
1396 jtag_add_reset(1, 0);
1400 jtag_add_reset(0, 0);
1405 LOG_ERROR("unknown TRST mode: %s", argus[1]);
1408 svf_para.trst_mode = i_tmp;
1409 LOG_DEBUG("\ttrst_mode = %s", svf_trst_mode_name[svf_para.trst_mode]);
1413 LOG_ERROR("can not accpet TRST command if trst_mode is ABSENT");
1418 LOG_ERROR("invalid svf command: %s", argus[0]);
1423 if (debug_level >= LOG_LVL_DEBUG)
1425 // for convenient debugging, execute tap if possible
1426 if ((svf_buffer_index > 0) && \
1427 (((command != STATE) && (command != RUNTEST)) || \
1428 ((command == STATE) && (num_of_argu == 2))))
1430 if (ERROR_OK != svf_execute_tap())
1435 // output debug info
1436 if ((SIR == command) || (SDR == command))
1439 memcpy(&read_value, svf_tdi_buffer, sizeof(int));
1440 // in debug mode, data is from index 0
1441 int read_mask = svf_get_mask_u32(svf_check_tdo_para[0].bit_len);
1442 LOG_DEBUG("\tTDO read = 0x%X", read_value & read_mask);
1448 // for fast executing, execute tap if necessary
1449 // half of the buffer is for the next command
1450 if (((svf_buffer_index >= SVF_MAX_BUFFER_SIZE_TO_COMMIT) || (svf_check_tdo_para_index >= SVF_CHECK_TDO_PARA_SIZE / 2)) && \
1451 (((command != STATE) && (command != RUNTEST)) || \
1452 ((command == STATE) && (num_of_argu == 2))))
1454 return svf_execute_tap();
1461 static const struct command_registration svf_command_handlers[] = {
1464 .handler = handle_svf_command,
1465 .mode = COMMAND_EXEC,
1466 .help = "Runs a SVF file.",
1467 .usage = "filename ['quiet']",
1469 COMMAND_REGISTRATION_DONE
1472 int svf_register_commands(struct command_context *cmd_ctx)
1474 return register_commands(cmd_ctx, NULL, svf_command_handlers);