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))
503 /* Don't save '\r' and '\n' if no data is parsed */
509 /* The parsing code currently expects a space
510 * before parentheses -- "TDI (123)". Also a
511 * space afterwards -- "TDI (123) TDO(456)".
512 * But such spaces are optional... instead of
513 * parser updates, cope with that by adding the
516 * Ensure there are 3 bytes available, for:
517 * - current character
519 * - terminating NUL ('\0')
521 if ((cmd_pos
+ 2) >= svf_command_buffer_size
)
523 /* REVISIT use realloc(); simpler */
525 svf_command_buffer_size
527 if (NULL
== tmp_buffer
)
529 LOG_ERROR("not enough memory");
532 if (svf_command_buffer_size
> 0)
535 svf_command_buffer_size
);
536 if (svf_command_buffer
!= NULL
)
537 free(svf_command_buffer
);
538 svf_command_buffer
= tmp_buffer
;
539 svf_command_buffer_size
+= SVFP_CMD_INC_CNT
;
543 /* insert a space before '(' */
545 svf_command_buffer
[cmd_pos
++] = ' ';
547 svf_command_buffer
[cmd_pos
++] = (char)toupper(ch
);
549 /* insert a space after ')' */
551 svf_command_buffer
[cmd_pos
++] = ' ';
559 svf_command_buffer
[cmd_pos
] = '\0';
568 static int svf_parse_cmd_string(char *str
, int len
, char **argus
, int *num_of_argu
)
570 int pos
= 0, num
= 0, space_found
= 1, in_bracket
= 0;
578 LOG_ERROR("fail to parse svf command");
588 if (!in_bracket
&& isspace((int) str
[pos
]))
593 else if (space_found
)
595 argus
[num
++] = &str
[pos
];
608 bool svf_tap_state_is_stable(tap_state_t state
)
610 return (TAP_RESET
== state
) || (TAP_IDLE
== state
)
611 || (TAP_DRPAUSE
== state
) || (TAP_IRPAUSE
== state
);
614 static int svf_find_string_in_array(char *str
, char **strs
, int num_of_element
)
618 for (i
= 0; i
< num_of_element
; i
++)
620 if (!strcmp(str
, strs
[i
]))
628 static int svf_adjust_array_length(uint8_t **arr
, int orig_bit_len
, int new_bit_len
)
630 int new_byte_len
= (new_bit_len
+ 7) >> 3;
632 if ((NULL
== *arr
) || (((orig_bit_len
+ 7) >> 3) < ((new_bit_len
+ 7) >> 3)))
639 *arr
= (uint8_t*)malloc(new_byte_len
);
642 LOG_ERROR("not enough memory");
645 memset(*arr
, 0, new_byte_len
);
650 static int svf_copy_hexstring_to_binary(char *str
, uint8_t **bin
, int orig_bit_len
, int bit_len
)
652 int i
, str_len
= strlen(str
), str_hbyte_len
= (bit_len
+ 3) >> 2;
655 if (ERROR_OK
!= svf_adjust_array_length(bin
, orig_bit_len
, bit_len
))
657 LOG_ERROR("fail to adjust length of array");
661 /* fill from LSB (end of str) to MSB (beginning of str) */
662 for (i
= 0; i
< str_hbyte_len
; i
++)
669 /* Skip whitespace. The SVF specification (rev E) is
670 * deficient in terms of basic lexical issues like
671 * where whitespace is allowed. Long bitstrings may
672 * require line ends for correctness, since there is
673 * a hard limit on line length.
677 if ((ch
>= '0') && (ch
<= '9'))
682 else if ((ch
>= 'A') && (ch
<= 'F'))
689 LOG_ERROR("invalid hex string");
701 (*bin
)[i
/ 2] |= ch
<< 4;
711 /* consume optional leading '0' MSBs or whitespace */
712 while (str_len
> 0 && ((str
[str_len
- 1] == '0')
713 || isspace((int) str
[str_len
- 1])))
716 /* check validity: we must have consumed everything */
717 if (str_len
> 0 || (ch
& ~((2 << ((bit_len
- 1) % 4)) - 1)) != 0)
719 LOG_ERROR("value execeeds length");
726 static int svf_check_tdo(void)
730 for (i
= 0; i
< svf_check_tdo_para_index
; i
++)
732 index
= svf_check_tdo_para
[i
].buffer_offset
;
733 len
= svf_check_tdo_para
[i
].bit_len
;
734 if ((svf_check_tdo_para
[i
].enabled
)
735 && buf_cmp_mask(&svf_tdi_buffer
[index
], &svf_tdo_buffer
[index
], &svf_mask_buffer
[index
], len
))
738 unsigned received
, expected
, tapmask
;
739 bitmask
= svf_get_mask_u32(svf_check_tdo_para
[i
].bit_len
);
741 memcpy(&received
, svf_tdi_buffer
+ index
, sizeof(unsigned));
742 memcpy(&expected
, svf_tdo_buffer
+ index
, sizeof(unsigned));
743 memcpy(&tapmask
, svf_mask_buffer
+ index
, sizeof(unsigned));
744 LOG_ERROR("tdo check error at line %d",
745 svf_check_tdo_para
[i
].line_num
);
746 LOG_ERROR("read = 0x%X, want = 0x%X, mask = 0x%X",
753 svf_check_tdo_para_index
= 0;
758 static int svf_add_check_para(uint8_t enabled
, int buffer_offset
, int bit_len
)
760 if (svf_check_tdo_para_index
>= SVF_CHECK_TDO_PARA_SIZE
)
762 LOG_ERROR("toooooo many operation undone");
766 svf_check_tdo_para
[svf_check_tdo_para_index
].line_num
= svf_line_number
;
767 svf_check_tdo_para
[svf_check_tdo_para_index
].bit_len
= bit_len
;
768 svf_check_tdo_para
[svf_check_tdo_para_index
].enabled
= enabled
;
769 svf_check_tdo_para
[svf_check_tdo_para_index
].buffer_offset
= buffer_offset
;
770 svf_check_tdo_para_index
++;
775 static int svf_execute_tap(void)
777 if (ERROR_OK
!= jtag_execute_queue())
781 else if (ERROR_OK
!= svf_check_tdo())
786 svf_buffer_index
= 0;
791 static int svf_run_command(struct command_context
*cmd_ctx
, char *cmd_str
)
793 char *argus
[256], command
;
794 int num_of_argu
= 0, i
;
801 float min_time
, max_time
;
803 struct svf_xxr_para
*xxr_para_tmp
;
804 uint8_t **pbuffer_tmp
;
805 struct scan_field field
;
807 tap_state_t
*path
= NULL
, state
;
811 LOG_USER("%s", svf_command_buffer
);
814 if (ERROR_OK
!= svf_parse_cmd_string(cmd_str
, strlen(cmd_str
), argus
, &num_of_argu
))
819 /* NOTE: we're a bit loose here, because we ignore case in
820 * TAP state names (instead of insisting on uppercase).
823 command
= svf_find_string_in_array(argus
[0],
824 (char **)svf_command_name
, ARRAY_SIZE(svf_command_name
));
829 if (num_of_argu
!= 2)
831 LOG_ERROR("invalid parameter of %s", argus
[0]);
835 i_tmp
= tap_state_by_name(argus
[1]);
837 if (svf_tap_state_is_stable(i_tmp
))
839 if (command
== ENDIR
)
841 svf_para
.ir_end_state
= i_tmp
;
842 LOG_DEBUG("\tIR end_state = %s",
843 tap_state_name(i_tmp
));
847 svf_para
.dr_end_state
= i_tmp
;
848 LOG_DEBUG("\tDR end_state = %s",
849 tap_state_name(i_tmp
));
854 LOG_ERROR("%s: %s is not a stable state",
860 if ((num_of_argu
!= 1) && (num_of_argu
!= 3))
862 LOG_ERROR("invalid parameter of %s", argus
[0]);
865 if (1 == num_of_argu
)
867 // TODO: set jtag speed to full speed
868 svf_para
.frequency
= 0;
872 if (strcmp(argus
[2], "HZ"))
874 LOG_ERROR("HZ not found in FREQUENCY command");
877 if (ERROR_OK
!= svf_execute_tap())
881 svf_para
.frequency
= atof(argus
[1]);
882 // TODO: set jtag speed to
883 if (svf_para
.frequency
> 0)
885 command_run_linef(cmd_ctx
, "jtag_khz %d", (int)svf_para
.frequency
/ 1000);
886 LOG_DEBUG("\tfrequency = %f", svf_para
.frequency
);
891 xxr_para_tmp
= &svf_para
.hdr_para
;
894 xxr_para_tmp
= &svf_para
.hir_para
;
897 xxr_para_tmp
= &svf_para
.tdr_para
;
900 xxr_para_tmp
= &svf_para
.tir_para
;
903 xxr_para_tmp
= &svf_para
.sdr_para
;
906 xxr_para_tmp
= &svf_para
.sir_para
;
909 // XXR length [TDI (tdi)] [TDO (tdo)][MASK (mask)] [SMASK (smask)]
910 if ((num_of_argu
> 10) || (num_of_argu
% 2))
912 LOG_ERROR("invalid parameter of %s", argus
[0]);
915 i_tmp
= xxr_para_tmp
->len
;
916 xxr_para_tmp
->len
= atoi(argus
[1]);
917 LOG_DEBUG("\tlength = %d", xxr_para_tmp
->len
);
918 xxr_para_tmp
->data_mask
= 0;
919 for (i
= 2; i
< num_of_argu
; i
+= 2)
921 if ((strlen(argus
[i
+ 1]) < 3) || (argus
[i
+ 1][0] != '(') || (argus
[i
+ 1][strlen(argus
[i
+ 1]) - 1] != ')'))
923 LOG_ERROR("data section error");
926 argus
[i
+ 1][strlen(argus
[i
+ 1]) - 1] = '\0';
927 // TDI, TDO, MASK, SMASK
928 if (!strcmp(argus
[i
], "TDI"))
931 pbuffer_tmp
= &xxr_para_tmp
->tdi
;
932 xxr_para_tmp
->data_mask
|= XXR_TDI
;
934 else if (!strcmp(argus
[i
], "TDO"))
937 pbuffer_tmp
= &xxr_para_tmp
->tdo
;
938 xxr_para_tmp
->data_mask
|= XXR_TDO
;
940 else if (!strcmp(argus
[i
], "MASK"))
943 pbuffer_tmp
= &xxr_para_tmp
->mask
;
944 xxr_para_tmp
->data_mask
|= XXR_MASK
;
946 else if (!strcmp(argus
[i
], "SMASK"))
949 pbuffer_tmp
= &xxr_para_tmp
->smask
;
950 xxr_para_tmp
->data_mask
|= XXR_SMASK
;
954 LOG_ERROR("unknow parameter: %s", argus
[i
]);
957 if (ERROR_OK
!= svf_copy_hexstring_to_binary(&argus
[i
+ 1][1], pbuffer_tmp
, i_tmp
, xxr_para_tmp
->len
))
959 LOG_ERROR("fail to parse hex value");
962 LOG_DEBUG("\t%s = 0x%X", argus
[i
], (**(int**)pbuffer_tmp
) & svf_get_mask_u32(xxr_para_tmp
->len
));
964 // If a command changes the length of the last scan of the same type and the MASK parameter is absent,
965 // the mask pattern used is all cares
966 if (!(xxr_para_tmp
->data_mask
& XXR_MASK
) && (i_tmp
!= xxr_para_tmp
->len
))
968 // MASK not defined and length changed
969 if (ERROR_OK
!= svf_adjust_array_length(&xxr_para_tmp
->mask
, i_tmp
, xxr_para_tmp
->len
))
971 LOG_ERROR("fail to adjust length of array");
974 buf_set_ones(xxr_para_tmp
->mask
, xxr_para_tmp
->len
);
976 // If TDO is absent, no comparison is needed, set the mask to 0
977 if (!(xxr_para_tmp
->data_mask
& XXR_TDO
))
979 if (NULL
== xxr_para_tmp
->tdo
)
981 if (ERROR_OK
!= svf_adjust_array_length(&xxr_para_tmp
->tdo
, i_tmp
, xxr_para_tmp
->len
))
983 LOG_ERROR("fail to adjust length of array");
987 if (NULL
== xxr_para_tmp
->mask
)
989 if (ERROR_OK
!= svf_adjust_array_length(&xxr_para_tmp
->mask
, i_tmp
, xxr_para_tmp
->len
))
991 LOG_ERROR("fail to adjust length of array");
995 memset(xxr_para_tmp
->mask
, 0, (xxr_para_tmp
->len
+ 7) >> 3);
997 // do scan if necessary
1000 // check buffer size first, reallocate if necessary
1001 i
= svf_para
.hdr_para
.len
+ svf_para
.sdr_para
.len
+ svf_para
.tdr_para
.len
;
1002 if ((svf_buffer_size
- svf_buffer_index
) < ((i
+ 7) >> 3))
1005 // simply print error message
1006 LOG_ERROR("buffer is not enough, report to author");
1009 uint8_t *buffer_tmp
;
1011 // reallocate buffer
1012 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1013 if (NULL
== buffer_tmp
)
1015 LOG_ERROR("not enough memory");
1018 memcpy(buffer_tmp
, svf_tdi_buffer
, svf_buffer_index
);
1019 // svf_tdi_buffer isn't NULL here
1020 free(svf_tdi_buffer
);
1021 svf_tdi_buffer
= buffer_tmp
;
1023 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1024 if (NULL
== buffer_tmp
)
1026 LOG_ERROR("not enough memory");
1029 memcpy(buffer_tmp
, svf_tdo_buffer
, svf_buffer_index
);
1030 // svf_tdo_buffer isn't NULL here
1031 free(svf_tdo_buffer
);
1032 svf_tdo_buffer
= buffer_tmp
;
1034 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1035 if (NULL
== buffer_tmp
)
1037 LOG_ERROR("not enough memory");
1040 memcpy(buffer_tmp
, svf_mask_buffer
, svf_buffer_index
);
1041 // svf_mask_buffer isn't NULL here
1042 free(svf_mask_buffer
);
1043 svf_mask_buffer
= buffer_tmp
;
1046 svf_buffer_size
= svf_buffer_index
+ ((i
+ 7) >> 3);
1052 buf_set_buf(svf_para
.hdr_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.hdr_para
.len
);
1053 i
+= svf_para
.hdr_para
.len
;
1054 buf_set_buf(svf_para
.sdr_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.sdr_para
.len
);
1055 i
+= svf_para
.sdr_para
.len
;
1056 buf_set_buf(svf_para
.tdr_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.tdr_para
.len
);
1057 i
+= svf_para
.tdr_para
.len
;
1060 if (svf_para
.sdr_para
.data_mask
& XXR_TDO
)
1062 // assemble dr mask data
1064 buf_set_buf(svf_para
.hdr_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.hdr_para
.len
);
1065 i
+= svf_para
.hdr_para
.len
;
1066 buf_set_buf(svf_para
.sdr_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.sdr_para
.len
);
1067 i
+= svf_para
.sdr_para
.len
;
1068 buf_set_buf(svf_para
.tdr_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.tdr_para
.len
);
1069 i
+= svf_para
.tdr_para
.len
;
1070 // assemble dr check data
1072 buf_set_buf(svf_para
.hdr_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.hdr_para
.len
);
1073 i
+= svf_para
.hdr_para
.len
;
1074 buf_set_buf(svf_para
.sdr_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.sdr_para
.len
);
1075 i
+= svf_para
.sdr_para
.len
;
1076 buf_set_buf(svf_para
.tdr_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.tdr_para
.len
);
1077 i
+= svf_para
.tdr_para
.len
;
1079 svf_add_check_para(1, svf_buffer_index
, i
);
1083 svf_add_check_para(0, svf_buffer_index
, i
);
1087 field
.out_value
= &svf_tdi_buffer
[svf_buffer_index
];
1088 field
.in_value
= &svf_tdi_buffer
[svf_buffer_index
];
1089 /* NOTE: doesn't use SVF-specified state paths */
1090 jtag_add_plain_dr_scan(1, &field
, svf_para
.dr_end_state
);
1092 svf_buffer_index
+= (i
+ 7) >> 3;
1094 else if (SIR
== command
)
1096 // check buffer size first, reallocate if necessary
1097 i
= svf_para
.hir_para
.len
+ svf_para
.sir_para
.len
+ svf_para
.tir_para
.len
;
1098 if ((svf_buffer_size
- svf_buffer_index
) < ((i
+ 7) >> 3))
1101 // simply print error message
1102 LOG_ERROR("buffer is not enough, report to author");
1105 uint8_t *buffer_tmp
;
1107 // reallocate buffer
1108 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1109 if (NULL
== buffer_tmp
)
1111 LOG_ERROR("not enough memory");
1114 memcpy(buffer_tmp
, svf_tdi_buffer
, svf_buffer_index
);
1115 // svf_tdi_buffer isn't NULL here
1116 free(svf_tdi_buffer
);
1117 svf_tdi_buffer
= buffer_tmp
;
1119 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1120 if (NULL
== buffer_tmp
)
1122 LOG_ERROR("not enough memory");
1125 memcpy(buffer_tmp
, svf_tdo_buffer
, svf_buffer_index
);
1126 // svf_tdo_buffer isn't NULL here
1127 free(svf_tdo_buffer
);
1128 svf_tdo_buffer
= buffer_tmp
;
1130 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1131 if (NULL
== buffer_tmp
)
1133 LOG_ERROR("not enough memory");
1136 memcpy(buffer_tmp
, svf_mask_buffer
, svf_buffer_index
);
1137 // svf_mask_buffer isn't NULL here
1138 free(svf_mask_buffer
);
1139 svf_mask_buffer
= buffer_tmp
;
1142 svf_buffer_size
= svf_buffer_index
+ ((i
+ 7) >> 3);
1148 buf_set_buf(svf_para
.hir_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.hir_para
.len
);
1149 i
+= svf_para
.hir_para
.len
;
1150 buf_set_buf(svf_para
.sir_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.sir_para
.len
);
1151 i
+= svf_para
.sir_para
.len
;
1152 buf_set_buf(svf_para
.tir_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.tir_para
.len
);
1153 i
+= svf_para
.tir_para
.len
;
1156 if (svf_para
.sir_para
.data_mask
& XXR_TDO
)
1158 // assemble dr mask data
1160 buf_set_buf(svf_para
.hir_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.hir_para
.len
);
1161 i
+= svf_para
.hir_para
.len
;
1162 buf_set_buf(svf_para
.sir_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.sir_para
.len
);
1163 i
+= svf_para
.sir_para
.len
;
1164 buf_set_buf(svf_para
.tir_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.tir_para
.len
);
1165 i
+= svf_para
.tir_para
.len
;
1166 // assemble dr check data
1168 buf_set_buf(svf_para
.hir_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.hir_para
.len
);
1169 i
+= svf_para
.hir_para
.len
;
1170 buf_set_buf(svf_para
.sir_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.sir_para
.len
);
1171 i
+= svf_para
.sir_para
.len
;
1172 buf_set_buf(svf_para
.tir_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.tir_para
.len
);
1173 i
+= svf_para
.tir_para
.len
;
1175 svf_add_check_para(1, svf_buffer_index
, i
);
1179 svf_add_check_para(0, svf_buffer_index
, i
);
1183 field
.out_value
= &svf_tdi_buffer
[svf_buffer_index
];
1184 field
.in_value
= &svf_tdi_buffer
[svf_buffer_index
];
1185 /* NOTE: doesn't use SVF-specified state paths */
1186 jtag_add_plain_ir_scan(1, &field
, svf_para
.ir_end_state
);
1188 svf_buffer_index
+= (i
+ 7) >> 3;
1193 LOG_ERROR("PIO and PIOMAP are not supported");
1197 // RUNTEST [run_state] run_count run_clk [min_time SEC [MAXIMUM max_time SEC]] [ENDSTATE end_state]
1198 // RUNTEST [run_state] min_time SEC [MAXIMUM max_time SEC] [ENDSTATE end_state]
1199 if ((num_of_argu
< 3) && (num_of_argu
> 11))
1201 LOG_ERROR("invalid parameter of %s", argus
[0]);
1211 i_tmp
= tap_state_by_name(argus
[i
]);
1212 if (i_tmp
!= TAP_INVALID
)
1214 if (svf_tap_state_is_stable(i_tmp
))
1216 svf_para
.runtest_run_state
= i_tmp
;
1218 /* When a run_state is specified, the new
1219 * run_state becomes the default end_state.
1221 svf_para
.runtest_end_state
= i_tmp
;
1222 LOG_DEBUG("\trun_state = %s",
1223 tap_state_name(i_tmp
));
1228 LOG_ERROR("%s: %s is not a stable state",
1229 argus
[0], tap_state_name(i_tmp
));
1234 // run_count run_clk
1235 if (((i
+ 2) <= num_of_argu
) && strcmp(argus
[i
+ 1], "SEC"))
1237 if (!strcmp(argus
[i
+ 1], "TCK"))
1239 // clock source is TCK
1240 run_count
= atoi(argus
[i
]);
1241 LOG_DEBUG("\trun_count@TCK = %d", run_count
);
1245 LOG_ERROR("%s not supported for clock", argus
[i
+ 1]);
1251 if (((i
+ 2) <= num_of_argu
) && !strcmp(argus
[i
+ 1], "SEC"))
1253 min_time
= atof(argus
[i
]);
1254 LOG_DEBUG("\tmin_time = %fs", min_time
);
1257 // MAXIMUM max_time SEC
1258 if (((i
+ 3) <= num_of_argu
) && !strcmp(argus
[i
], "MAXIMUM") && !strcmp(argus
[i
+ 2], "SEC"))
1260 max_time
= atof(argus
[i
+ 1]);
1261 LOG_DEBUG("\tmax_time = %fs", max_time
);
1264 // ENDSTATE end_state
1265 if (((i
+ 2) <= num_of_argu
) && !strcmp(argus
[i
], "ENDSTATE"))
1267 i_tmp
= tap_state_by_name(argus
[i
+ 1]);
1269 if (svf_tap_state_is_stable(i_tmp
))
1271 svf_para
.runtest_end_state
= i_tmp
;
1272 LOG_DEBUG("\tend_state = %s",
1273 tap_state_name(i_tmp
));
1277 LOG_ERROR("%s: %s is not a stable state",
1278 argus
[0], tap_state_name(i_tmp
));
1283 // calculate run_count
1284 if ((0 == run_count
) && (min_time
> 0))
1286 run_count
= min_time
* svf_para
.frequency
;
1288 // all parameter should be parsed
1289 if (i
== num_of_argu
)
1293 // run_state and end_state is checked to be stable state
1296 /* FIXME handle statemove failures */
1299 // enter into run_state if necessary
1300 if (cmd_queue_cur_state
!= svf_para
.runtest_run_state
)
1302 retval
= svf_add_statemove(svf_para
.runtest_run_state
);
1305 // call jtag_add_clocks
1306 jtag_add_clocks(run_count
);
1308 // move to end_state if necessary
1309 if (svf_para
.runtest_end_state
!= svf_para
.runtest_run_state
)
1311 retval
= svf_add_statemove(svf_para
.runtest_end_state
);
1314 if (svf_para
.runtest_run_state
!= TAP_IDLE
)
1316 LOG_ERROR("cannot runtest in %s state",
1317 tap_state_name(svf_para
.runtest_run_state
));
1321 jtag_add_runtest(run_count
, svf_para
.runtest_end_state
);
1327 LOG_ERROR("fail to parse parameter of RUNTEST, %d out of %d is parsed", i
, num_of_argu
);
1332 // STATE [pathstate1 [pathstate2 ...[pathstaten]]] stable_state
1333 if (num_of_argu
< 2)
1335 LOG_ERROR("invalid parameter of %s", argus
[0]);
1338 if (num_of_argu
> 2)
1340 // STATE pathstate1 ... stable_state
1341 path
= (tap_state_t
*)malloc((num_of_argu
- 1) * sizeof(tap_state_t
));
1344 LOG_ERROR("not enough memory");
1347 num_of_argu
--; // num of path
1348 i_tmp
= 1; /* path is from parameter 1 */
1349 for (i
= 0; i
< num_of_argu
; i
++, i_tmp
++)
1351 path
[i
] = tap_state_by_name(argus
[i_tmp
]);
1352 if (path
[i
] == TAP_INVALID
)
1354 LOG_ERROR("%s: %s is not a valid state",
1355 argus
[0], argus
[i_tmp
]);
1359 /* OpenOCD refuses paths containing TAP_RESET */
1360 if (TAP_RESET
== path
[i
])
1362 /* FIXME last state MUST be stable! */
1365 jtag_add_pathmove(i
, path
);
1368 num_of_argu
-= i
+ 1;
1372 if (num_of_argu
> 0)
1374 // execute last path if necessary
1375 if (svf_tap_state_is_stable(path
[num_of_argu
- 1]))
1377 // last state MUST be stable state
1378 jtag_add_pathmove(num_of_argu
, path
);
1379 LOG_DEBUG("\tmove to %s by path_move",
1380 tap_state_name(path
[num_of_argu
- 1]));
1384 LOG_ERROR("%s: %s is not a stable state",
1386 tap_state_name(path
[num_of_argu
- 1]));
1397 // STATE stable_state
1398 state
= tap_state_by_name(argus
[1]);
1399 if (svf_tap_state_is_stable(state
))
1401 LOG_DEBUG("\tmove to %s by svf_add_statemove",
1402 tap_state_name(state
));
1403 /* FIXME handle statemove failures */
1404 svf_add_statemove(state
);
1408 LOG_ERROR("%s: %s is not a stable state",
1409 argus
[0], tap_state_name(state
));
1416 if (num_of_argu
!= 2)
1418 LOG_ERROR("invalid parameter of %s", argus
[0]);
1421 if (svf_para
.trst_mode
!= TRST_ABSENT
)
1423 if (ERROR_OK
!= svf_execute_tap())
1427 i_tmp
= svf_find_string_in_array(argus
[1],
1428 (char **)svf_trst_mode_name
,
1429 ARRAY_SIZE(svf_trst_mode_name
));
1433 jtag_add_reset(1, 0);
1437 jtag_add_reset(0, 0);
1442 LOG_ERROR("unknown TRST mode: %s", argus
[1]);
1445 svf_para
.trst_mode
= i_tmp
;
1446 LOG_DEBUG("\ttrst_mode = %s", svf_trst_mode_name
[svf_para
.trst_mode
]);
1450 LOG_ERROR("can not accpet TRST command if trst_mode is ABSENT");
1455 LOG_ERROR("invalid svf command: %s", argus
[0]);
1460 if (debug_level
>= LOG_LVL_DEBUG
)
1462 // for convenient debugging, execute tap if possible
1463 if ((svf_buffer_index
> 0) && \
1464 (((command
!= STATE
) && (command
!= RUNTEST
)) || \
1465 ((command
== STATE
) && (num_of_argu
== 2))))
1467 if (ERROR_OK
!= svf_execute_tap())
1472 // output debug info
1473 if ((SIR
== command
) || (SDR
== command
))
1476 memcpy(&read_value
, svf_tdi_buffer
, sizeof(int));
1477 // in debug mode, data is from index 0
1478 int read_mask
= svf_get_mask_u32(svf_check_tdo_para
[0].bit_len
);
1479 LOG_DEBUG("\tTDO read = 0x%X", read_value
& read_mask
);
1485 // for fast executing, execute tap if necessary
1486 // half of the buffer is for the next command
1487 if (((svf_buffer_index
>= SVF_MAX_BUFFER_SIZE_TO_COMMIT
) || (svf_check_tdo_para_index
>= SVF_CHECK_TDO_PARA_SIZE
/ 2)) && \
1488 (((command
!= STATE
) && (command
!= RUNTEST
)) || \
1489 ((command
== STATE
) && (num_of_argu
== 2))))
1491 return svf_execute_tap();
1498 static const struct command_registration svf_command_handlers
[] = {
1501 .handler
= handle_svf_command
,
1502 .mode
= COMMAND_EXEC
,
1503 .help
= "Runs a SVF file.",
1504 .usage
= "filename ['quiet']",
1506 COMMAND_REGISTRATION_DONE
1509 int svf_register_commands(struct command_context
*cmd_ctx
)
1511 return register_commands(cmd_ctx
, NULL
, svf_command_handlers
);
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)