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".
36 #include "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
)
473 char ch
, *tmp_buffer
= NULL
;
474 int cmd_pos
= 0, cmd_ok
= 0, slash
= 0, comment
= 0;
476 while (!cmd_ok
&& (read(fd
, &ch
, 1) > 0))
506 if (cmd_pos
>= svf_command_buffer_size
- 1)
508 tmp_buffer
= (char*)malloc(svf_command_buffer_size
+ SVFP_CMD_INC_CNT
); // 1 more byte for '\0'
509 if (NULL
== tmp_buffer
)
511 LOG_ERROR("not enough memory");
514 if (svf_command_buffer_size
> 0)
516 memcpy(tmp_buffer
, svf_command_buffer
, svf_command_buffer_size
);
518 if (svf_command_buffer
!= NULL
)
520 free(svf_command_buffer
);
522 svf_command_buffer
= tmp_buffer
;
523 svf_command_buffer_size
+= SVFP_CMD_INC_CNT
;
526 svf_command_buffer
[cmd_pos
++] = (char)toupper(ch
);
534 svf_command_buffer
[cmd_pos
] = '\0';
543 static int svf_parse_cmd_string(char *str
, int len
, char **argus
, int *num_of_argu
)
545 int pos
= 0, num
= 0, space_found
= 1;
555 LOG_ERROR("fail to parse svf command");
565 argus
[num
++] = &str
[pos
];
578 bool svf_tap_state_is_stable(tap_state_t state
)
580 return (TAP_RESET
== state
) || (TAP_IDLE
== state
)
581 || (TAP_DRPAUSE
== state
) || (TAP_IRPAUSE
== state
);
584 static int svf_find_string_in_array(char *str
, char **strs
, int num_of_element
)
588 for (i
= 0; i
< num_of_element
; i
++)
590 if (!strcmp(str
, strs
[i
]))
598 static int svf_adjust_array_length(uint8_t **arr
, int orig_bit_len
, int new_bit_len
)
600 int new_byte_len
= (new_bit_len
+ 7) >> 3;
602 if ((NULL
== *arr
) || (((orig_bit_len
+ 7) >> 3) < ((new_bit_len
+ 7) >> 3)))
609 *arr
= (uint8_t*)malloc(new_byte_len
);
612 LOG_ERROR("not enough memory");
615 memset(*arr
, 0, new_byte_len
);
620 static int svf_copy_hexstring_to_binary(char *str
, uint8_t **bin
, int orig_bit_len
, int bit_len
)
622 int i
, str_len
= strlen(str
), str_hbyte_len
= (bit_len
+ 3) >> 2;
625 if (ERROR_OK
!= svf_adjust_array_length(bin
, orig_bit_len
, bit_len
))
627 LOG_ERROR("fail to adjust length of array");
631 for (i
= 0; i
< str_hbyte_len
; i
++)
640 if ((ch
>= '0') && (ch
<= '9'))
645 else if ((ch
>= 'A') && (ch
<= 'F'))
652 LOG_ERROR("invalid hex string");
664 (*bin
)[i
/ 2] |= ch
<< 4;
674 // consume optional leading '0' characters
675 while (str_len
> 0 && str
[str_len
- 1] == '0')
679 if (str_len
> 0 || (ch
& ~((2 << ((bit_len
- 1) % 4)) - 1)) != 0)
681 LOG_ERROR("value execeeds length");
688 static int svf_check_tdo(void)
692 for (i
= 0; i
< svf_check_tdo_para_index
; i
++)
694 index
= svf_check_tdo_para
[i
].buffer_offset
;
695 len
= svf_check_tdo_para
[i
].bit_len
;
696 if ((svf_check_tdo_para
[i
].enabled
)
697 && buf_cmp_mask(&svf_tdi_buffer
[index
], &svf_tdo_buffer
[index
], &svf_mask_buffer
[index
], len
))
700 unsigned received
, expected
, tapmask
;
701 bitmask
= svf_get_mask_u32(svf_check_tdo_para
[i
].bit_len
);
703 memcpy(&received
, svf_tdi_buffer
+ index
, sizeof(unsigned));
704 memcpy(&expected
, svf_tdo_buffer
+ index
, sizeof(unsigned));
705 memcpy(&tapmask
, svf_mask_buffer
+ index
, sizeof(unsigned));
706 LOG_ERROR("tdo check error at line %d",
707 svf_check_tdo_para
[i
].line_num
);
708 LOG_ERROR("read = 0x%X, want = 0x%X, mask = 0x%X",
715 svf_check_tdo_para_index
= 0;
720 static int svf_add_check_para(uint8_t enabled
, int buffer_offset
, int bit_len
)
722 if (svf_check_tdo_para_index
>= SVF_CHECK_TDO_PARA_SIZE
)
724 LOG_ERROR("toooooo many operation undone");
728 svf_check_tdo_para
[svf_check_tdo_para_index
].line_num
= svf_line_number
;
729 svf_check_tdo_para
[svf_check_tdo_para_index
].bit_len
= bit_len
;
730 svf_check_tdo_para
[svf_check_tdo_para_index
].enabled
= enabled
;
731 svf_check_tdo_para
[svf_check_tdo_para_index
].buffer_offset
= buffer_offset
;
732 svf_check_tdo_para_index
++;
737 static int svf_execute_tap(void)
739 if (ERROR_OK
!= jtag_execute_queue())
743 else if (ERROR_OK
!= svf_check_tdo())
748 svf_buffer_index
= 0;
753 static int svf_run_command(struct command_context
*cmd_ctx
, char *cmd_str
)
755 char *argus
[256], command
;
756 int num_of_argu
= 0, i
;
763 float min_time
, max_time
;
765 struct svf_xxr_para
*xxr_para_tmp
;
766 uint8_t **pbuffer_tmp
;
767 struct scan_field field
;
769 tap_state_t
*path
= NULL
, state
;
773 LOG_USER("%s", svf_command_buffer
);
776 if (ERROR_OK
!= svf_parse_cmd_string(cmd_str
, strlen(cmd_str
), argus
, &num_of_argu
))
781 /* NOTE: we're a bit loose here, because we ignore case in
782 * TAP state names (instead of insisting on uppercase).
785 command
= svf_find_string_in_array(argus
[0],
786 (char **)svf_command_name
, ARRAY_SIZE(svf_command_name
));
791 if (num_of_argu
!= 2)
793 LOG_ERROR("invalid parameter of %s", argus
[0]);
797 i_tmp
= tap_state_by_name(argus
[1]);
799 if (svf_tap_state_is_stable(i_tmp
))
801 if (command
== ENDIR
)
803 svf_para
.ir_end_state
= i_tmp
;
804 LOG_DEBUG("\tIR end_state = %s",
805 tap_state_name(i_tmp
));
809 svf_para
.dr_end_state
= i_tmp
;
810 LOG_DEBUG("\tDR end_state = %s",
811 tap_state_name(i_tmp
));
816 LOG_ERROR("%s: %s is not a stable state",
822 if ((num_of_argu
!= 1) && (num_of_argu
!= 3))
824 LOG_ERROR("invalid parameter of %s", argus
[0]);
827 if (1 == num_of_argu
)
829 // TODO: set jtag speed to full speed
830 svf_para
.frequency
= 0;
834 if (strcmp(argus
[2], "HZ"))
836 LOG_ERROR("HZ not found in FREQUENCY command");
839 if (ERROR_OK
!= svf_execute_tap())
843 svf_para
.frequency
= atof(argus
[1]);
844 // TODO: set jtag speed to
845 if (svf_para
.frequency
> 0)
847 command_run_linef(cmd_ctx
, "jtag_khz %d", (int)svf_para
.frequency
/ 1000);
848 LOG_DEBUG("\tfrequency = %f", svf_para
.frequency
);
853 xxr_para_tmp
= &svf_para
.hdr_para
;
856 xxr_para_tmp
= &svf_para
.hir_para
;
859 xxr_para_tmp
= &svf_para
.tdr_para
;
862 xxr_para_tmp
= &svf_para
.tir_para
;
865 xxr_para_tmp
= &svf_para
.sdr_para
;
868 xxr_para_tmp
= &svf_para
.sir_para
;
871 // XXR length [TDI (tdi)] [TDO (tdo)][MASK (mask)] [SMASK (smask)]
872 if ((num_of_argu
> 10) || (num_of_argu
% 2))
874 LOG_ERROR("invalid parameter of %s", argus
[0]);
877 i_tmp
= xxr_para_tmp
->len
;
878 xxr_para_tmp
->len
= atoi(argus
[1]);
879 LOG_DEBUG("\tlength = %d", xxr_para_tmp
->len
);
880 xxr_para_tmp
->data_mask
= 0;
881 for (i
= 2; i
< num_of_argu
; i
+= 2)
883 if ((strlen(argus
[i
+ 1]) < 3) || (argus
[i
+ 1][0] != '(') || (argus
[i
+ 1][strlen(argus
[i
+ 1]) - 1] != ')'))
885 LOG_ERROR("data section error");
888 argus
[i
+ 1][strlen(argus
[i
+ 1]) - 1] = '\0';
889 // TDI, TDO, MASK, SMASK
890 if (!strcmp(argus
[i
], "TDI"))
893 pbuffer_tmp
= &xxr_para_tmp
->tdi
;
894 xxr_para_tmp
->data_mask
|= XXR_TDI
;
896 else if (!strcmp(argus
[i
], "TDO"))
899 pbuffer_tmp
= &xxr_para_tmp
->tdo
;
900 xxr_para_tmp
->data_mask
|= XXR_TDO
;
902 else if (!strcmp(argus
[i
], "MASK"))
905 pbuffer_tmp
= &xxr_para_tmp
->mask
;
906 xxr_para_tmp
->data_mask
|= XXR_MASK
;
908 else if (!strcmp(argus
[i
], "SMASK"))
911 pbuffer_tmp
= &xxr_para_tmp
->smask
;
912 xxr_para_tmp
->data_mask
|= XXR_SMASK
;
916 LOG_ERROR("unknow parameter: %s", argus
[i
]);
919 if (ERROR_OK
!= svf_copy_hexstring_to_binary(&argus
[i
+ 1][1], pbuffer_tmp
, i_tmp
, xxr_para_tmp
->len
))
921 LOG_ERROR("fail to parse hex value");
924 LOG_DEBUG("\t%s = 0x%X", argus
[i
], (**(int**)pbuffer_tmp
) & svf_get_mask_u32(xxr_para_tmp
->len
));
926 // If a command changes the length of the last scan of the same type and the MASK parameter is absent,
927 // the mask pattern used is all cares
928 if (!(xxr_para_tmp
->data_mask
& XXR_MASK
) && (i_tmp
!= xxr_para_tmp
->len
))
930 // MASK not defined and length changed
931 if (ERROR_OK
!= svf_adjust_array_length(&xxr_para_tmp
->mask
, i_tmp
, xxr_para_tmp
->len
))
933 LOG_ERROR("fail to adjust length of array");
936 buf_set_ones(xxr_para_tmp
->mask
, xxr_para_tmp
->len
);
938 // If TDO is absent, no comparison is needed, set the mask to 0
939 if (!(xxr_para_tmp
->data_mask
& XXR_TDO
))
941 if (NULL
== xxr_para_tmp
->tdo
)
943 if (ERROR_OK
!= svf_adjust_array_length(&xxr_para_tmp
->tdo
, i_tmp
, xxr_para_tmp
->len
))
945 LOG_ERROR("fail to adjust length of array");
949 if (NULL
== xxr_para_tmp
->mask
)
951 if (ERROR_OK
!= svf_adjust_array_length(&xxr_para_tmp
->mask
, i_tmp
, xxr_para_tmp
->len
))
953 LOG_ERROR("fail to adjust length of array");
957 memset(xxr_para_tmp
->mask
, 0, (xxr_para_tmp
->len
+ 7) >> 3);
959 // do scan if necessary
962 // check buffer size first, reallocate if necessary
963 i
= svf_para
.hdr_para
.len
+ svf_para
.sdr_para
.len
+ svf_para
.tdr_para
.len
;
964 if ((svf_buffer_size
- svf_buffer_index
) < ((i
+ 7) >> 3))
967 // simply print error message
968 LOG_ERROR("buffer is not enough, report to author");
974 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
975 if (NULL
== buffer_tmp
)
977 LOG_ERROR("not enough memory");
980 memcpy(buffer_tmp
, svf_tdi_buffer
, svf_buffer_index
);
981 // svf_tdi_buffer isn't NULL here
982 free(svf_tdi_buffer
);
983 svf_tdi_buffer
= buffer_tmp
;
985 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
986 if (NULL
== buffer_tmp
)
988 LOG_ERROR("not enough memory");
991 memcpy(buffer_tmp
, svf_tdo_buffer
, svf_buffer_index
);
992 // svf_tdo_buffer isn't NULL here
993 free(svf_tdo_buffer
);
994 svf_tdo_buffer
= buffer_tmp
;
996 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
997 if (NULL
== buffer_tmp
)
999 LOG_ERROR("not enough memory");
1002 memcpy(buffer_tmp
, svf_mask_buffer
, svf_buffer_index
);
1003 // svf_mask_buffer isn't NULL here
1004 free(svf_mask_buffer
);
1005 svf_mask_buffer
= buffer_tmp
;
1008 svf_buffer_size
= svf_buffer_index
+ ((i
+ 7) >> 3);
1014 buf_set_buf(svf_para
.hdr_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.hdr_para
.len
);
1015 i
+= svf_para
.hdr_para
.len
;
1016 buf_set_buf(svf_para
.sdr_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.sdr_para
.len
);
1017 i
+= svf_para
.sdr_para
.len
;
1018 buf_set_buf(svf_para
.tdr_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.tdr_para
.len
);
1019 i
+= svf_para
.tdr_para
.len
;
1022 if (svf_para
.sdr_para
.data_mask
& XXR_TDO
)
1024 // assemble dr mask data
1026 buf_set_buf(svf_para
.hdr_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.hdr_para
.len
);
1027 i
+= svf_para
.hdr_para
.len
;
1028 buf_set_buf(svf_para
.sdr_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.sdr_para
.len
);
1029 i
+= svf_para
.sdr_para
.len
;
1030 buf_set_buf(svf_para
.tdr_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.tdr_para
.len
);
1031 i
+= svf_para
.tdr_para
.len
;
1032 // assemble dr check data
1034 buf_set_buf(svf_para
.hdr_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.hdr_para
.len
);
1035 i
+= svf_para
.hdr_para
.len
;
1036 buf_set_buf(svf_para
.sdr_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.sdr_para
.len
);
1037 i
+= svf_para
.sdr_para
.len
;
1038 buf_set_buf(svf_para
.tdr_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.tdr_para
.len
);
1039 i
+= svf_para
.tdr_para
.len
;
1041 svf_add_check_para(1, svf_buffer_index
, i
);
1045 svf_add_check_para(0, svf_buffer_index
, i
);
1049 field
.out_value
= &svf_tdi_buffer
[svf_buffer_index
];
1050 field
.in_value
= &svf_tdi_buffer
[svf_buffer_index
];
1051 /* NOTE: doesn't use SVF-specified state paths */
1052 jtag_add_plain_dr_scan(1, &field
, svf_para
.dr_end_state
);
1054 svf_buffer_index
+= (i
+ 7) >> 3;
1056 else if (SIR
== command
)
1058 // check buffer size first, reallocate if necessary
1059 i
= svf_para
.hir_para
.len
+ svf_para
.sir_para
.len
+ svf_para
.tir_para
.len
;
1060 if ((svf_buffer_size
- svf_buffer_index
) < ((i
+ 7) >> 3))
1063 // simply print error message
1064 LOG_ERROR("buffer is not enough, report to author");
1067 uint8_t *buffer_tmp
;
1069 // reallocate buffer
1070 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1071 if (NULL
== buffer_tmp
)
1073 LOG_ERROR("not enough memory");
1076 memcpy(buffer_tmp
, svf_tdi_buffer
, svf_buffer_index
);
1077 // svf_tdi_buffer isn't NULL here
1078 free(svf_tdi_buffer
);
1079 svf_tdi_buffer
= buffer_tmp
;
1081 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1082 if (NULL
== buffer_tmp
)
1084 LOG_ERROR("not enough memory");
1087 memcpy(buffer_tmp
, svf_tdo_buffer
, svf_buffer_index
);
1088 // svf_tdo_buffer isn't NULL here
1089 free(svf_tdo_buffer
);
1090 svf_tdo_buffer
= buffer_tmp
;
1092 buffer_tmp
= (uint8_t *)malloc(svf_buffer_index
+ ((i
+ 7) >> 3));
1093 if (NULL
== buffer_tmp
)
1095 LOG_ERROR("not enough memory");
1098 memcpy(buffer_tmp
, svf_mask_buffer
, svf_buffer_index
);
1099 // svf_mask_buffer isn't NULL here
1100 free(svf_mask_buffer
);
1101 svf_mask_buffer
= buffer_tmp
;
1104 svf_buffer_size
= svf_buffer_index
+ ((i
+ 7) >> 3);
1110 buf_set_buf(svf_para
.hir_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.hir_para
.len
);
1111 i
+= svf_para
.hir_para
.len
;
1112 buf_set_buf(svf_para
.sir_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.sir_para
.len
);
1113 i
+= svf_para
.sir_para
.len
;
1114 buf_set_buf(svf_para
.tir_para
.tdi
, 0, &svf_tdi_buffer
[svf_buffer_index
], i
, svf_para
.tir_para
.len
);
1115 i
+= svf_para
.tir_para
.len
;
1118 if (svf_para
.sir_para
.data_mask
& XXR_TDO
)
1120 // assemble dr mask data
1122 buf_set_buf(svf_para
.hir_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.hir_para
.len
);
1123 i
+= svf_para
.hir_para
.len
;
1124 buf_set_buf(svf_para
.sir_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.sir_para
.len
);
1125 i
+= svf_para
.sir_para
.len
;
1126 buf_set_buf(svf_para
.tir_para
.mask
, 0, &svf_mask_buffer
[svf_buffer_index
], i
, svf_para
.tir_para
.len
);
1127 i
+= svf_para
.tir_para
.len
;
1128 // assemble dr check data
1130 buf_set_buf(svf_para
.hir_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.hir_para
.len
);
1131 i
+= svf_para
.hir_para
.len
;
1132 buf_set_buf(svf_para
.sir_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.sir_para
.len
);
1133 i
+= svf_para
.sir_para
.len
;
1134 buf_set_buf(svf_para
.tir_para
.tdo
, 0, &svf_tdo_buffer
[svf_buffer_index
], i
, svf_para
.tir_para
.len
);
1135 i
+= svf_para
.tir_para
.len
;
1137 svf_add_check_para(1, svf_buffer_index
, i
);
1141 svf_add_check_para(0, svf_buffer_index
, i
);
1145 field
.out_value
= &svf_tdi_buffer
[svf_buffer_index
];
1146 field
.in_value
= &svf_tdi_buffer
[svf_buffer_index
];
1147 /* NOTE: doesn't use SVF-specified state paths */
1148 jtag_add_plain_ir_scan(1, &field
, svf_para
.ir_end_state
);
1150 svf_buffer_index
+= (i
+ 7) >> 3;
1155 LOG_ERROR("PIO and PIOMAP are not supported");
1159 // RUNTEST [run_state] run_count run_clk [min_time SEC [MAXIMUM max_time SEC]] [ENDSTATE end_state]
1160 // RUNTEST [run_state] min_time SEC [MAXIMUM max_time SEC] [ENDSTATE end_state]
1161 if ((num_of_argu
< 3) && (num_of_argu
> 11))
1163 LOG_ERROR("invalid parameter of %s", argus
[0]);
1173 i_tmp
= tap_state_by_name(argus
[i
]);
1174 if (i_tmp
!= TAP_INVALID
)
1176 if (svf_tap_state_is_stable(i_tmp
))
1178 svf_para
.runtest_run_state
= i_tmp
;
1180 /* When a run_state is specified, the new
1181 * run_state becomes the default end_state.
1183 svf_para
.runtest_end_state
= i_tmp
;
1184 LOG_DEBUG("\trun_state = %s",
1185 tap_state_name(i_tmp
));
1190 LOG_ERROR("%s: %s is not a stable state",
1191 argus
[0], tap_state_name(i_tmp
));
1196 // run_count run_clk
1197 if (((i
+ 2) <= num_of_argu
) && strcmp(argus
[i
+ 1], "SEC"))
1199 if (!strcmp(argus
[i
+ 1], "TCK"))
1201 // clock source is TCK
1202 run_count
= atoi(argus
[i
]);
1203 LOG_DEBUG("\trun_count@TCK = %d", run_count
);
1207 LOG_ERROR("%s not supported for clock", argus
[i
+ 1]);
1213 if (((i
+ 2) <= num_of_argu
) && !strcmp(argus
[i
+ 1], "SEC"))
1215 min_time
= atof(argus
[i
]);
1216 LOG_DEBUG("\tmin_time = %fs", min_time
);
1219 // MAXIMUM max_time SEC
1220 if (((i
+ 3) <= num_of_argu
) && !strcmp(argus
[i
], "MAXIMUM") && !strcmp(argus
[i
+ 2], "SEC"))
1222 max_time
= atof(argus
[i
+ 1]);
1223 LOG_DEBUG("\tmax_time = %fs", max_time
);
1226 // ENDSTATE end_state
1227 if (((i
+ 2) <= num_of_argu
) && !strcmp(argus
[i
], "ENDSTATE"))
1229 i_tmp
= tap_state_by_name(argus
[i
+ 1]);
1231 if (svf_tap_state_is_stable(i_tmp
))
1233 svf_para
.runtest_end_state
= i_tmp
;
1234 LOG_DEBUG("\tend_state = %s",
1235 tap_state_name(i_tmp
));
1239 LOG_ERROR("%s: %s is not a stable state",
1240 argus
[0], tap_state_name(i_tmp
));
1245 // calculate run_count
1246 if ((0 == run_count
) && (min_time
> 0))
1248 run_count
= min_time
* svf_para
.frequency
;
1250 // all parameter should be parsed
1251 if (i
== num_of_argu
)
1255 // run_state and end_state is checked to be stable state
1258 /* FIXME handle statemove failures */
1261 // enter into run_state if necessary
1262 if (cmd_queue_cur_state
!= svf_para
.runtest_run_state
)
1264 retval
= svf_add_statemove(svf_para
.runtest_run_state
);
1267 // call jtag_add_clocks
1268 jtag_add_clocks(run_count
);
1270 // move to end_state if necessary
1271 if (svf_para
.runtest_end_state
!= svf_para
.runtest_run_state
)
1273 retval
= svf_add_statemove(svf_para
.runtest_end_state
);
1276 if (svf_para
.runtest_run_state
!= TAP_IDLE
)
1278 LOG_ERROR("cannot runtest in %s state",
1279 tap_state_name(svf_para
.runtest_run_state
));
1283 jtag_add_runtest(run_count
, svf_para
.runtest_end_state
);
1289 LOG_ERROR("fail to parse parameter of RUNTEST, %d out of %d is parsed", i
, num_of_argu
);
1294 // STATE [pathstate1 [pathstate2 ...[pathstaten]]] stable_state
1295 if (num_of_argu
< 2)
1297 LOG_ERROR("invalid parameter of %s", argus
[0]);
1300 if (num_of_argu
> 2)
1302 // STATE pathstate1 ... stable_state
1303 path
= (tap_state_t
*)malloc((num_of_argu
- 1) * sizeof(tap_state_t
));
1306 LOG_ERROR("not enough memory");
1309 num_of_argu
--; // num of path
1310 i_tmp
= 1; /* path is from parameter 1 */
1311 for (i
= 0; i
< num_of_argu
; i
++, i_tmp
++)
1313 path
[i
] = tap_state_by_name(argus
[i_tmp
]);
1314 if (path
[i
] == TAP_INVALID
)
1316 LOG_ERROR("%s: %s is not a valid state",
1317 argus
[0], argus
[i_tmp
]);
1321 /* OpenOCD refuses paths containing TAP_RESET */
1322 if (TAP_RESET
== path
[i
])
1324 /* FIXME last state MUST be stable! */
1327 jtag_add_pathmove(i
, path
);
1330 num_of_argu
-= i
+ 1;
1334 if (num_of_argu
> 0)
1336 // execute last path if necessary
1337 if (svf_tap_state_is_stable(path
[num_of_argu
- 1]))
1339 // last state MUST be stable state
1340 jtag_add_pathmove(num_of_argu
, path
);
1341 LOG_DEBUG("\tmove to %s by path_move",
1342 tap_state_name(path
[num_of_argu
- 1]));
1346 LOG_ERROR("%s: %s is not a stable state",
1348 tap_state_name(path
[num_of_argu
- 1]));
1353 // no need to keep this memory, in jtag_add_pathmove, path will be duplicated
1362 // STATE stable_state
1363 state
= tap_state_by_name(argus
[1]);
1364 if (svf_tap_state_is_stable(state
))
1366 LOG_DEBUG("\tmove to %s by svf_add_statemove",
1367 tap_state_name(state
));
1368 /* FIXME handle statemove failures */
1369 svf_add_statemove(state
);
1373 LOG_ERROR("%s: %s is not a stable state",
1374 argus
[0], tap_state_name(state
));
1381 if (num_of_argu
!= 2)
1383 LOG_ERROR("invalid parameter of %s", argus
[0]);
1386 if (svf_para
.trst_mode
!= TRST_ABSENT
)
1388 if (ERROR_OK
!= svf_execute_tap())
1392 i_tmp
= svf_find_string_in_array(argus
[1],
1393 (char **)svf_trst_mode_name
,
1394 ARRAY_SIZE(svf_trst_mode_name
));
1398 jtag_add_reset(1, 0);
1402 jtag_add_reset(0, 0);
1407 LOG_ERROR("unknown TRST mode: %s", argus
[1]);
1410 svf_para
.trst_mode
= i_tmp
;
1411 LOG_DEBUG("\ttrst_mode = %s", svf_trst_mode_name
[svf_para
.trst_mode
]);
1415 LOG_ERROR("can not accpet TRST command if trst_mode is ABSENT");
1420 LOG_ERROR("invalid svf command: %s", argus
[0]);
1425 if (debug_level
>= LOG_LVL_DEBUG
)
1427 // for convenient debugging, execute tap if possible
1428 if ((svf_buffer_index
> 0) && \
1429 (((command
!= STATE
) && (command
!= RUNTEST
)) || \
1430 ((command
== STATE
) && (num_of_argu
== 2))))
1432 if (ERROR_OK
!= svf_execute_tap())
1437 // output debug info
1438 if ((SIR
== command
) || (SDR
== command
))
1441 memcpy(&read_value
, svf_tdi_buffer
, sizeof(int));
1442 // in debug mode, data is from index 0
1443 int read_mask
= svf_get_mask_u32(svf_check_tdo_para
[0].bit_len
);
1444 LOG_DEBUG("\tTDO read = 0x%X", read_value
& read_mask
);
1450 // for fast executing, execute tap if necessary
1451 // half of the buffer is for the next command
1452 if (((svf_buffer_index
>= SVF_MAX_BUFFER_SIZE_TO_COMMIT
) || (svf_check_tdo_para_index
>= SVF_CHECK_TDO_PARA_SIZE
/ 2)) && \
1453 (((command
!= STATE
) && (command
!= RUNTEST
)) || \
1454 ((command
== STATE
) && (num_of_argu
== 2))))
1456 return svf_execute_tap();
1463 static const struct command_registration svf_command_handlers
[] = {
1466 .handler
= &handle_svf_command
,
1467 .mode
= COMMAND_EXEC
,
1468 .help
= "Runs a SVF file.",
1471 COMMAND_REGISTRATION_DONE
1474 int svf_register_commands(struct command_context
*cmd_ctx
)
1476 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)