Code Review / openocd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
Move Doxygen documentation for IR/DR scan routines to header file.
[openocd.git] / src / jtag / jtag.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2009 SoftPLC Corporation *
9 * http://softplc.com *
10 * dick@softplc.com *
11 * *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
16 * *
17 * This program is distributed in the hope that it will be useful, *
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
20 * GNU General Public License for more details. *
21 * *
22 * You should have received a copy of the GNU General Public License *
23 * along with this program; if not, write to the *
24 * Free Software Foundation, Inc., *
25 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
26 ***************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include "jtag.h"
32 #include "minidriver.h"
33 #include "interface.h"
34
35 #ifdef HAVE_STRINGS_H
36 #include <strings.h>
37 #endif
38
39
40 /// The number of JTAG queue flushes (for profiling and debugging purposes).
41 static int jtag_flush_queue_count;
42
43 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
44 int in_num_fields, scan_field_t *in_fields, tap_state_t state);
45
46 /* note that this is not marked as static as it must be available from outside jtag.c for those
47 that implement the jtag_xxx() minidriver layer
48 */
49 int jtag_error=ERROR_OK;
50
51 char* jtag_event_strings[] =
52 {
53 "JTAG controller reset (RESET or TRST)"
54 };
55
56 const Jim_Nvp nvp_jtag_tap_event[] = {
57 { .value = JTAG_TAP_EVENT_ENABLE, .name = "tap-enable" },
58 { .value = JTAG_TAP_EVENT_DISABLE, .name = "tap-disable" },
59
60 { .name = NULL, .value = -1 }
61 };
62
63 int jtag_trst = 0;
64 int jtag_srst = 0;
65
66 /**
67 * List all TAPs that have been created.
68 */
69 static jtag_tap_t *__jtag_all_taps = NULL;
70 /**
71 * The number of TAPs in the __jtag_all_taps list, used to track the
72 * assigned chain position to new TAPs
73 */
74 static unsigned jtag_num_taps = 0;
75
76 enum reset_types jtag_reset_config = RESET_NONE;
77 tap_state_t cmd_queue_end_state = TAP_RESET;
78 tap_state_t cmd_queue_cur_state = TAP_RESET;
79
80 int jtag_verify_capture_ir = 1;
81 int jtag_verify = 1;
82
83 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
84 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
85 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
86
87 /* callbacks to inform high-level handlers about JTAG state changes */
88 jtag_event_callback_t *jtag_event_callbacks;
89
90 /* speed in kHz*/
91 static int speed_khz = 0;
92 /* flag if the kHz speed was defined */
93 static bool hasKHz = false;
94
95 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
96 */
97
98 #if BUILD_ECOSBOARD == 1
99 extern jtag_interface_t zy1000_interface;
100 #elif defined(BUILD_MINIDRIVER_DUMMY)
101 extern jtag_interface_t minidummy_interface;
102 #else // standard drivers
103 #if BUILD_PARPORT == 1
104 extern jtag_interface_t parport_interface;
105 #endif
106
107 #if BUILD_DUMMY == 1
108 extern jtag_interface_t dummy_interface;
109 #endif
110
111 #if BUILD_FT2232_FTD2XX == 1
112 extern jtag_interface_t ft2232_interface;
113 #endif
114
115 #if BUILD_FT2232_LIBFTDI == 1
116 extern jtag_interface_t ft2232_interface;
117 #endif
118
119 #if BUILD_AMTJTAGACCEL == 1
120 extern jtag_interface_t amt_jtagaccel_interface;
121 #endif
122
123 #if BUILD_EP93XX == 1
124 extern jtag_interface_t ep93xx_interface;
125 #endif
126
127 #if BUILD_AT91RM9200 == 1
128 extern jtag_interface_t at91rm9200_interface;
129 #endif
130
131 #if BUILD_GW16012 == 1
132 extern jtag_interface_t gw16012_interface;
133 #endif
134
135 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
136 extern jtag_interface_t presto_interface;
137 #endif
138
139 #if BUILD_USBPROG == 1
140 extern jtag_interface_t usbprog_interface;
141 #endif
142
143 #if BUILD_JLINK == 1
144 extern jtag_interface_t jlink_interface;
145 #endif
146
147 #if BUILD_VSLLINK == 1
148 extern jtag_interface_t vsllink_interface;
149 #endif
150
151 #if BUILD_RLINK == 1
152 extern jtag_interface_t rlink_interface;
153 #endif
154
155 #if BUILD_ARMJTAGEW == 1
156 extern jtag_interface_t armjtagew_interface;
157 #endif
158 #endif // standard drivers
159
160 /**
161 * The list of built-in JTAG interfaces, containing entries for those
162 * drivers that were enabled by the @c configure script.
163 *
164 * The list should be defined to contain either one minidriver interface
165 * or some number of standard driver interfaces, never both.
166 */
167 jtag_interface_t *jtag_interfaces[] = {
168 #if BUILD_ECOSBOARD == 1
169 &zy1000_interface,
170 #elif defined(BUILD_MINIDRIVER_DUMMY)
171 &minidummy_interface,
172 #else // standard drivers
173 #if BUILD_PARPORT == 1
174 &parport_interface,
175 #endif
176 #if BUILD_DUMMY == 1
177 &dummy_interface,
178 #endif
179 #if BUILD_FT2232_FTD2XX == 1
180 &ft2232_interface,
181 #endif
182 #if BUILD_FT2232_LIBFTDI == 1
183 &ft2232_interface,
184 #endif
185 #if BUILD_AMTJTAGACCEL == 1
186 &amt_jtagaccel_interface,
187 #endif
188 #if BUILD_EP93XX == 1
189 &ep93xx_interface,
190 #endif
191 #if BUILD_AT91RM9200 == 1
192 &at91rm9200_interface,
193 #endif
194 #if BUILD_GW16012 == 1
195 &gw16012_interface,
196 #endif
197 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
198 &presto_interface,
199 #endif
200 #if BUILD_USBPROG == 1
201 &usbprog_interface,
202 #endif
203 #if BUILD_JLINK == 1
204 &jlink_interface,
205 #endif
206 #if BUILD_VSLLINK == 1
207 &vsllink_interface,
208 #endif
209 #if BUILD_RLINK == 1
210 &rlink_interface,
211 #endif
212 #if BUILD_ARMJTAGEW == 1
213 &armjtagew_interface,
214 #endif
215 #endif // standard drivers
216 NULL,
217 };
218
219 struct jtag_interface_s *jtag = NULL;
220
221 /* configuration */
222 static jtag_interface_t *jtag_interface = NULL;
223 int jtag_speed = 0;
224
225 /* jtag commands */
226 static int handle_interface_list_command(struct command_context_s *cmd_ctx,
227 char *cmd, char **args, int argc);
228 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
229 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
230 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
231 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
232 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
233 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
234 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
235
236 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
237
238 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
239 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
240 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
241 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
242 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
243
244 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
245 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
246 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
247
248 jtag_tap_t *jtag_all_taps(void)
249 {
250 return __jtag_all_taps;
251 };
252
253 unsigned jtag_tap_count(void)
254 {
255 return jtag_num_taps;
256 }
257
258 unsigned jtag_tap_count_enabled(void)
259 {
260 jtag_tap_t *t = jtag_all_taps();
261 unsigned n = 0;
262 while(t)
263 {
264 if (t->enabled)
265 n++;
266 t = t->next_tap;
267 }
268 return n;
269 }
270
271 /// Append a new TAP to the chain of all taps.
272 void jtag_tap_add(struct jtag_tap_s *t)
273 {
274 t->abs_chain_position = jtag_num_taps++;
275
276 jtag_tap_t **tap = &__jtag_all_taps;
277 while(*tap != NULL)
278 tap = &(*tap)->next_tap;
279 *tap = t;
280 }
281
282 jtag_tap_t *jtag_tap_by_string(const char *s)
283 {
284 /* try by name first */
285 jtag_tap_t *t = jtag_all_taps();
286 while (t)
287 {
288 if (0 == strcmp(t->dotted_name, s))
289 return t;
290 t = t->next_tap;
291 }
292
293 /* no tap found by name, so try to parse the name as a number */
294 char *cp;
295 unsigned n = strtoul(s, &cp, 0);
296 if ((s == cp) || (*cp != 0))
297 return NULL;
298
299 return jtag_tap_by_position(n);
300 }
301
302 jtag_tap_t *jtag_tap_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
303 {
304 const char *cp = Jim_GetString(o, NULL);
305 jtag_tap_t *t = cp ? jtag_tap_by_string(cp) : NULL;
306 if (NULL == cp)
307 cp = "(unknown)";
308 if (NULL == t)
309 Jim_SetResult_sprintf(interp, "Tap '%s' could not be found", cp);
310 return t;
311 }
312
313 /* returns a pointer to the n-th device in the scan chain */
314 jtag_tap_t *jtag_tap_by_position(unsigned n)
315 {
316 jtag_tap_t *t = jtag_all_taps();
317
318 while (t && n-- > 0)
319 t = t->next_tap;
320
321 return t;
322 }
323
324 const char *jtag_tap_name(const jtag_tap_t *tap)
325 {
326 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
327 }
328
329
330 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
331 {
332 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
333
334 if (callback == NULL)
335 {
336 return ERROR_INVALID_ARGUMENTS;
337 }
338
339 if (*callbacks_p)
340 {
341 while ((*callbacks_p)->next)
342 callbacks_p = &((*callbacks_p)->next);
343 callbacks_p = &((*callbacks_p)->next);
344 }
345
346 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
347 (*callbacks_p)->callback = callback;
348 (*callbacks_p)->priv = priv;
349 (*callbacks_p)->next = NULL;
350
351 return ERROR_OK;
352 }
353
354 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
355 {
356 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
357
358 if (callback == NULL)
359 {
360 return ERROR_INVALID_ARGUMENTS;
361 }
362
363 while (*callbacks_p)
364 {
365 jtag_event_callback_t **next = &((*callbacks_p)->next);
366 if ((*callbacks_p)->callback == callback)
367 {
368 free(*callbacks_p);
369 *callbacks_p = *next;
370 }
371 callbacks_p = next;
372 }
373
374 return ERROR_OK;
375 }
376
377 int jtag_call_event_callbacks(enum jtag_event event)
378 {
379 jtag_event_callback_t *callback = jtag_event_callbacks;
380
381 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
382
383 while (callback)
384 {
385 callback->callback(event, callback->priv);
386 callback = callback->next;
387 }
388
389 return ERROR_OK;
390 }
391
392 static void jtag_checks(void)
393 {
394 assert(jtag_trst == 0);
395 }
396
397 static void jtag_prelude(tap_state_t state)
398 {
399 jtag_checks();
400
401 assert(state!=TAP_INVALID);
402
403 cmd_queue_cur_state = state;
404 }
405
406 void jtag_alloc_in_value32(scan_field_t *field)
407 {
408 interface_jtag_alloc_in_value32(field);
409 }
410
411 void jtag_add_ir_scan_noverify(int in_count, const scan_field_t *in_fields,
412 tap_state_t state)
413 {
414 jtag_prelude(state);
415
416 int retval = interface_jtag_add_ir_scan(in_count, in_fields, state);
417 jtag_set_error(retval);
418 }
419
420
421 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
422 {
423 if (jtag_verify&&jtag_verify_capture_ir)
424 {
425 /* 8 x 32 bit id's is enough for all invocations */
426
427 for (int j = 0; j < in_num_fields; j++)
428 {
429 /* if we are to run a verification of the ir scan, we need to get the input back.
430 * We may have to allocate space if the caller didn't ask for the input back.
431 */
432 in_fields[j].check_value=in_fields[j].tap->expected;
433 in_fields[j].check_mask=in_fields[j].tap->expected_mask;
434 }
435 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
436 } else
437 {
438 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
439 }
440 }
441
442 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields,
443 tap_state_t state)
444 {
445 jtag_prelude(state);
446
447 int retval = interface_jtag_add_plain_ir_scan(
448 in_num_fields, in_fields, state);
449 jtag_set_error(retval);
450 }
451
452 void jtag_add_callback(jtag_callback1_t f, u8 *in)
453 {
454 interface_jtag_add_callback(f, in);
455 }
456
457 void jtag_add_callback4(jtag_callback_t f, u8 *in,
458 jtag_callback_data_t data1, jtag_callback_data_t data2,
459 jtag_callback_data_t data3)
460 {
461 interface_jtag_add_callback4(f, in, data1, data2, data3);
462 }
463
464 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
465
466 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
467 {
468 return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
469 }
470
471 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
472 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
473 {
474 for (int i = 0; i < in_num_fields; i++)
475 {
476 struct scan_field_s *field = &in_fields[i];
477 field->allocated = 0;
478 field->modified = 0;
479 if (field->check_value || field->in_value)
480 continue;
481 interface_jtag_add_scan_check_alloc(field);
482 field->modified = 1;
483 }
484
485 jtag_add_scan(in_num_fields, in_fields, state);
486
487 for (int i = 0; i < in_num_fields; i++)
488 {
489 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
490 {
491 /* this is synchronous for a minidriver */
492 jtag_add_callback4(jtag_check_value_mask_callback, in_fields[i].in_value,
493 (jtag_callback_data_t)in_fields[i].check_value,
494 (jtag_callback_data_t)in_fields[i].check_mask,
495 (jtag_callback_data_t)in_fields[i].num_bits);
496 }
497 if (in_fields[i].allocated)
498 {
499 free(in_fields[i].in_value);
500 }
501 if (in_fields[i].modified)
502 {
503 in_fields[i].in_value = NULL;
504 }
505 }
506 }
507
508 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
509 {
510 if (jtag_verify)
511 {
512 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
513 } else
514 {
515 jtag_add_dr_scan(in_num_fields, in_fields, state);
516 }
517 }
518
519
520 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields,
521 tap_state_t state)
522 {
523 jtag_prelude(state);
524
525 int retval;
526 retval = interface_jtag_add_dr_scan(in_num_fields, in_fields, state);
527 jtag_set_error(retval);
528 }
529
530 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields,
531 tap_state_t state)
532 {
533 jtag_prelude(state);
534
535 int retval;
536 retval = interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, state);
537 jtag_set_error(retval);
538 }
539
540 void jtag_add_dr_out(jtag_tap_t* tap,
541 int num_fields, const int* num_bits, const u32* value,
542 tap_state_t end_state)
543 {
544 assert(end_state != TAP_INVALID);
545
546 cmd_queue_cur_state = end_state;
547
548 interface_jtag_add_dr_out(tap,
549 num_fields, num_bits, value,
550 end_state);
551 }
552
553 void jtag_add_tlr(void)
554 {
555 jtag_prelude(TAP_RESET);
556 jtag_set_error(interface_jtag_add_tlr());
557 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
558 }
559
560 void jtag_add_pathmove(int num_states, const tap_state_t *path)
561 {
562 tap_state_t cur_state = cmd_queue_cur_state;
563
564 /* the last state has to be a stable state */
565 if (!tap_is_state_stable(path[num_states - 1]))
566 {
567 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
568 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
569 return;
570 }
571
572 for (int i = 0; i < num_states; i++)
573 {
574 if (path[i] == TAP_RESET)
575 {
576 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
577 jtag_set_error(ERROR_JTAG_STATE_INVALID);
578 return;
579 }
580
581 if ( tap_state_transition(cur_state, true) != path[i]
582 && tap_state_transition(cur_state, false) != path[i])
583 {
584 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
585 tap_state_name(cur_state), tap_state_name(path[i]));
586 jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
587 return;
588 }
589 cur_state = path[i];
590 }
591
592 jtag_checks();
593
594 jtag_set_error(interface_jtag_add_pathmove(num_states, path));
595 cmd_queue_cur_state = path[num_states - 1];
596 }
597
598 void jtag_add_runtest(int num_cycles, tap_state_t state)
599 {
600 jtag_prelude(state);
601 jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
602 }
603
604
605 void jtag_add_clocks(int num_cycles)
606 {
607 if (!tap_is_state_stable(cmd_queue_cur_state))
608 {
609 LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
610 tap_state_name(cmd_queue_cur_state));
611 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
612 return;
613 }
614
615 if (num_cycles > 0)
616 {
617 jtag_checks();
618 jtag_set_error(interface_jtag_add_clocks(num_cycles));
619 }
620 }
621
622 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
623 {
624 int trst_with_tlr = 0;
625
626 /* FIX!!! there are *many* different cases here. A better
627 * approach is needed for legal combinations of transitions...
628 */
629 if ((jtag_reset_config & RESET_HAS_SRST)&&
630 (jtag_reset_config & RESET_HAS_TRST)&&
631 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
632 {
633 if (((req_tlr_or_trst&&!jtag_trst)||
634 (!req_tlr_or_trst&&jtag_trst))&&
635 ((req_srst&&!jtag_srst)||
636 (!req_srst&&jtag_srst)))
637 {
638 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
639 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
640 }
641 }
642
643 /* Make sure that jtag_reset_config allows the requested reset */
644 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
645 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
646 {
647 LOG_ERROR("BUG: requested reset would assert trst");
648 jtag_set_error(ERROR_FAIL);
649 return;
650 }
651
652 /* if TRST pulls SRST, we reset with TAP T-L-R */
653 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
654 {
655 trst_with_tlr = 1;
656 }
657
658 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
659 {
660 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
661 jtag_set_error(ERROR_FAIL);
662 return;
663 }
664
665 if (req_tlr_or_trst)
666 {
667 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
668 {
669 jtag_trst = 1;
670 } else
671 {
672 trst_with_tlr = 1;
673 }
674 } else
675 {
676 jtag_trst = 0;
677 }
678
679 jtag_srst = req_srst;
680
681 int retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
682 if (retval != ERROR_OK)
683 {
684 jtag_set_error(retval);
685 return;
686 }
687 jtag_execute_queue();
688
689 if (jtag_srst)
690 {
691 LOG_DEBUG("SRST line asserted");
692 }
693 else
694 {
695 LOG_DEBUG("SRST line released");
696 if (jtag_nsrst_delay)
697 jtag_add_sleep(jtag_nsrst_delay * 1000);
698 }
699
700 if (trst_with_tlr)
701 {
702 LOG_DEBUG("JTAG reset with RESET instead of TRST");
703 jtag_set_end_state(TAP_RESET);
704 jtag_add_tlr();
705 return;
706 }
707
708 if (jtag_trst)
709 {
710 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
711 * and inform possible listeners about this
712 */
713 LOG_DEBUG("TRST line asserted");
714 tap_set_state(TAP_RESET);
715 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
716 }
717 else
718 {
719 if (jtag_ntrst_delay)
720 jtag_add_sleep(jtag_ntrst_delay * 1000);
721 }
722 }
723
724 tap_state_t jtag_set_end_state(tap_state_t state)
725 {
726 if ((state == TAP_DRSHIFT)||(state == TAP_IRSHIFT))
727 {
728 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
729 }
730
731 if (state!=TAP_INVALID)
732 cmd_queue_end_state = state;
733 return cmd_queue_end_state;
734 }
735
736 tap_state_t jtag_get_end_state(void)
737 {
738 return cmd_queue_end_state;
739 }
740
741 void jtag_add_sleep(u32 us)
742 {
743 /// @todo Here, keep_alive() appears to be a layering violation!!!
744 keep_alive();
745 jtag_set_error(interface_jtag_add_sleep(us));
746 }
747
748 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
749 {
750 int retval = ERROR_OK;
751
752 int compare_failed = 0;
753
754 if (in_check_mask)
755 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
756 else
757 compare_failed = buf_cmp(captured, in_check_value, num_bits);
758
759 if (compare_failed){
760 /* An error handler could have caught the failing check
761 * only report a problem when there wasn't a handler, or if the handler
762 * acknowledged the error
763 */
764 /*
765 LOG_WARNING("TAP %s:",
766 jtag_tap_name(field->tap));
767 */
768 if (compare_failed)
769 {
770 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
771 char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
772
773 if (in_check_mask)
774 {
775 char *in_check_mask_char;
776 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
777 LOG_WARNING("value captured during scan didn't pass the requested check:");
778 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
779 captured_char, in_check_value_char, in_check_mask_char);
780 free(in_check_mask_char);
781 }
782 else
783 {
784 LOG_WARNING("value captured during scan didn't pass the requested check: captured: 0x%s check_value: 0x%s", captured_char, in_check_value_char);
785 }
786
787 free(captured_char);
788 free(in_check_value_char);
789
790 retval = ERROR_JTAG_QUEUE_FAILED;
791 }
792
793 }
794 return retval;
795 }
796
797 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
798 {
799 assert(field->in_value != NULL);
800
801 if (value==NULL)
802 {
803 /* no checking to do */
804 return;
805 }
806
807 jtag_execute_queue_noclear();
808
809 int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
810 jtag_set_error(retval);
811 }
812
813
814
815 int default_interface_jtag_execute_queue(void)
816 {
817 if (NULL == jtag)
818 {
819 LOG_ERROR("No JTAG interface configured yet. "
820 "Issue 'init' command in startup scripts "
821 "before communicating with targets.");
822 return ERROR_FAIL;
823 }
824
825 return jtag->execute_queue();
826 }
827
828 void jtag_execute_queue_noclear(void)
829 {
830 jtag_flush_queue_count++;
831 jtag_set_error(interface_jtag_execute_queue());
832 }
833
834 int jtag_get_flush_queue_count(void)
835 {
836 return jtag_flush_queue_count;
837 }
838
839 int jtag_execute_queue(void)
840 {
841 jtag_execute_queue_noclear();
842 return jtag_error_clear();
843 }
844
845 static int jtag_reset_callback(enum jtag_event event, void *priv)
846 {
847 jtag_tap_t *tap = priv;
848
849 LOG_DEBUG("-");
850
851 if (event == JTAG_TRST_ASSERTED)
852 {
853 buf_set_ones(tap->cur_instr, tap->ir_length);
854 tap->bypass = 1;
855 }
856
857 return ERROR_OK;
858 }
859
860 void jtag_sleep(u32 us)
861 {
862 alive_sleep(us/1000);
863 }
864
865 /// maximum number of JTAG devices expected in the chain
866 #define JTAG_MAX_CHAIN_SIZE 20
867
868 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
869 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
870 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
871
872 static int jtag_examine_chain_execute(u8 *idcode_buffer, unsigned num_idcode)
873 {
874 scan_field_t field = {
875 .tap = NULL,
876 .num_bits = num_idcode * 32,
877 .out_value = idcode_buffer,
878 .in_value = idcode_buffer,
879 };
880
881 // initialize to the end of chain ID value
882 for (unsigned i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
883 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
884
885 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
886 return jtag_execute_queue();
887 }
888
889 static bool jtag_examine_chain_check(u8 *idcodes, unsigned count)
890 {
891 u8 zero_check = 0x0;
892 u8 one_check = 0xff;
893
894 for (unsigned i = 0; i < count * 4; i++)
895 {
896 zero_check |= idcodes[i];
897 one_check &= idcodes[i];
898 }
899
900 /* if there wasn't a single non-zero bit or if all bits were one,
901 * the scan is not valid */
902 if (zero_check == 0x00 || one_check == 0xff)
903 {
904 LOG_ERROR("JTAG communication failure: check connection, "
905 "JTAG interface, target power etc.");
906 return false;
907 }
908 return true;
909 }
910
911 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
912 const char *name, u32 idcode)
913 {
914 log_printf_lf(level, __FILE__, __LINE__, __FUNCTION__,
915 "JTAG tap: %s %16.16s: 0x%08x "
916 "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
917 name, msg, idcode,
918 EXTRACT_MFG(idcode), EXTRACT_PART(idcode), EXTRACT_VER(idcode) );
919 }
920
921 static bool jtag_idcode_is_final(u32 idcode)
922 {
923 return idcode == 0x000000FF || idcode == 0xFFFFFFFF;
924 }
925
926 /**
927 * This helper checks that remaining bits in the examined chain data are
928 * all as expected, but a single JTAG device requires only 64 bits to be
929 * read back correctly. This can help identify and diagnose problems
930 * with the JTAG chain earlier, gives more helpful/explicit error messages.
931 */
932 static void jtag_examine_chain_end(u8 *idcodes, unsigned count, unsigned max)
933 {
934 bool triggered = false;
935 for ( ; count < max - 31; count += 32)
936 {
937 u32 idcode = buf_get_u32(idcodes, count, 32);
938 // do not trigger the warning if the data looks good
939 if (!triggered && jtag_idcode_is_final(idcode))
940 continue;
941 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
942 count, idcode);
943 triggered = true;
944 }
945 }
946
947 static bool jtag_examine_chain_match_tap(const struct jtag_tap_s *tap)
948 {
949 if (0 == tap->expected_ids_cnt)
950 {
951 /// @todo Enable LOG_INFO to ask for reports about unknown TAP IDs.
952 #if 0
953 LOG_INFO("Uknown JTAG TAP ID: 0x%08x", tap->idcode)
954 LOG_INFO("Please report the chip name and reported ID code to the openocd project");
955 #endif
956 return true;
957 }
958
959 /* Loop over the expected identification codes and test for a match */
960 u8 ii;
961 for (ii = 0; ii < tap->expected_ids_cnt; ii++)
962 {
963 if (tap->idcode == tap->expected_ids[ii])
964 break;
965 }
966
967 /* If none of the expected ids matched, log an error */
968 if (ii != tap->expected_ids_cnt)
969 {
970 LOG_INFO("JTAG Tap/device matched");
971 return true;
972 }
973 jtag_examine_chain_display(LOG_LVL_ERROR, "got",
974 tap->dotted_name, tap->idcode);
975 for (ii = 0; ii < tap->expected_ids_cnt; ii++)
976 {
977 char msg[32];
978 snprintf(msg, sizeof(msg), "expected %hhu of %hhu",
979 ii + 1, tap->expected_ids_cnt);
980 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
981 tap->dotted_name, tap->expected_ids[ii]);
982 }
983 return false;
984 }
985
986 /* Try to examine chain layout according to IEEE 1149.1 §12
987 */
988 static int jtag_examine_chain(void)
989 {
990 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
991 unsigned device_count = 0;
992
993 jtag_examine_chain_execute(idcode_buffer, JTAG_MAX_CHAIN_SIZE);
994
995 if (!jtag_examine_chain_check(idcode_buffer, JTAG_MAX_CHAIN_SIZE))
996 return ERROR_JTAG_INIT_FAILED;
997
998 /* point at the 1st tap */
999 jtag_tap_t *tap = jtag_tap_next_enabled(NULL);
1000 if (tap == NULL)
1001 {
1002 LOG_ERROR("JTAG: No taps enabled?");
1003 return ERROR_JTAG_INIT_FAILED;
1004 }
1005
1006 for (unsigned bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1007 {
1008 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1009 if ((idcode & 1) == 0)
1010 {
1011 /* LSB must not be 0, this indicates a device in bypass */
1012 LOG_WARNING("Tap/Device does not have IDCODE");
1013 idcode = 0;
1014
1015 bit_count += 1;
1016 }
1017 else
1018 {
1019 /*
1020 * End of chain (invalid manufacturer ID) some devices, such
1021 * as AVR will output all 1's instead of TDI input value at
1022 * end of chain.
1023 */
1024 if (jtag_idcode_is_final(idcode))
1025 {
1026 jtag_examine_chain_end(idcode_buffer,
1027 bit_count + 32, JTAG_MAX_CHAIN_SIZE * 32);
1028 break;
1029 }
1030
1031 jtag_examine_chain_display(LOG_LVL_INFO, "tap/device found",
1032 tap ? tap->dotted_name : "(not-named)",
1033 idcode);
1034
1035 bit_count += 32;
1036 }
1037 device_count++;
1038 if (!tap)
1039 continue;
1040
1041 tap->idcode = idcode;
1042
1043 // ensure the TAP ID does matches what was expected
1044 if (!jtag_examine_chain_match_tap(tap))
1045 return ERROR_JTAG_INIT_FAILED;
1046
1047 tap = jtag_tap_next_enabled(tap);
1048 }
1049
1050 /* see if number of discovered devices matches configuration */
1051 if (device_count != jtag_tap_count_enabled())
1052 {
1053 LOG_ERROR("number of discovered devices in JTAG chain (%i) "
1054 "does not match (enabled) configuration (%i), total taps: %d",
1055 device_count, jtag_tap_count_enabled(), jtag_tap_count());
1056 LOG_ERROR("check the config file and ensure proper JTAG communication"
1057 " (connections, speed, ...)");
1058 return ERROR_JTAG_INIT_FAILED;
1059 }
1060
1061 return ERROR_OK;
1062 }
1063
1064 static int jtag_validate_chain(void)
1065 {
1066 jtag_tap_t *tap;
1067 int total_ir_length = 0;
1068 u8 *ir_test = NULL;
1069 scan_field_t field;
1070 int chain_pos = 0;
1071
1072 tap = NULL;
1073 total_ir_length = 0;
1074 for(;;){
1075 tap = jtag_tap_next_enabled(tap);
1076 if( tap == NULL ){
1077 break;
1078 }
1079 total_ir_length += tap->ir_length;
1080 }
1081
1082 total_ir_length += 2;
1083 ir_test = malloc(CEIL(total_ir_length, 8));
1084 buf_set_ones(ir_test, total_ir_length);
1085
1086 field.tap = NULL;
1087 field.num_bits = total_ir_length;
1088 field.out_value = ir_test;
1089 field.in_value = ir_test;
1090
1091
1092 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1093 jtag_execute_queue();
1094
1095 tap = NULL;
1096 chain_pos = 0;
1097 int val;
1098 for(;;){
1099 tap = jtag_tap_next_enabled(tap);
1100 if( tap == NULL ){
1101 break;
1102 }
1103
1104 val = buf_get_u32(ir_test, chain_pos, 2);
1105 if (val != 0x1)
1106 {
1107 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1108 LOG_ERROR("Could not validate JTAG scan chain, IR mismatch, scan returned 0x%s. tap=%s pos=%d expected 0x1 got %0x", cbuf, jtag_tap_name(tap), chain_pos, val);
1109 free(cbuf);
1110 free(ir_test);
1111 return ERROR_JTAG_INIT_FAILED;
1112 }
1113 chain_pos += tap->ir_length;
1114 }
1115
1116 val = buf_get_u32(ir_test, chain_pos, 2);
1117 if (val != 0x3)
1118 {
1119 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1120 LOG_ERROR("Could not validate end of JTAG scan chain, IR mismatch, scan returned 0x%s. pos=%d expected 0x3 got %0x", cbuf, chain_pos, val);
1121 free(cbuf);
1122 free(ir_test);
1123 return ERROR_JTAG_INIT_FAILED;
1124 }
1125
1126 free(ir_test);
1127
1128 return ERROR_OK;
1129 }
1130
1131 enum jtag_tap_cfg_param {
1132 JCFG_EVENT
1133 };
1134
1135 static Jim_Nvp nvp_config_opts[] = {
1136 { .name = "-event", .value = JCFG_EVENT },
1137
1138 { .name = NULL, .value = -1 }
1139 };
1140
1141 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1142 {
1143 Jim_Nvp *n;
1144 Jim_Obj *o;
1145 int e;
1146
1147 /* parse config or cget options */
1148 while (goi->argc > 0) {
1149 Jim_SetEmptyResult (goi->interp);
1150
1151 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1152 if (e != JIM_OK) {
1153 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1154 return e;
1155 }
1156
1157 switch (n->value) {
1158 case JCFG_EVENT:
1159 if (goi->argc == 0) {
1160 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1161 return JIM_ERR;
1162 }
1163
1164 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1165 if (e != JIM_OK) {
1166 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1167 return e;
1168 }
1169
1170 if (goi->isconfigure) {
1171 if (goi->argc != 1) {
1172 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1173 return JIM_ERR;
1174 }
1175 } else {
1176 if (goi->argc != 0) {
1177 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1178 return JIM_ERR;
1179 }
1180 }
1181
1182 {
1183 jtag_tap_event_action_t *jteap;
1184
1185 jteap = tap->event_action;
1186 /* replace existing? */
1187 while (jteap) {
1188 if (jteap->event == (enum jtag_tap_event)n->value) {
1189 break;
1190 }
1191 jteap = jteap->next;
1192 }
1193
1194 if (goi->isconfigure) {
1195 if (jteap == NULL) {
1196 /* create new */
1197 jteap = calloc(1, sizeof (*jteap));
1198 }
1199 jteap->event = n->value;
1200 Jim_GetOpt_Obj( goi, &o);
1201 if (jteap->body) {
1202 Jim_DecrRefCount(interp, jteap->body);
1203 }
1204 jteap->body = Jim_DuplicateObj(goi->interp, o);
1205 Jim_IncrRefCount(jteap->body);
1206
1207 /* add to head of event list */
1208 jteap->next = tap->event_action;
1209 tap->event_action = jteap;
1210 Jim_SetEmptyResult(goi->interp);
1211 } else {
1212 /* get */
1213 if (jteap == NULL) {
1214 Jim_SetEmptyResult(goi->interp);
1215 } else {
1216 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1217 }
1218 }
1219 }
1220 /* loop for more */
1221 break;
1222 }
1223 } /* while (goi->argc) */
1224
1225 return JIM_OK;
1226 }
1227
1228
1229 static void jtag_tap_init(jtag_tap_t *tap)
1230 {
1231 assert(0 != tap->ir_length);
1232
1233 tap->expected = malloc(tap->ir_length);
1234 tap->expected_mask = malloc(tap->ir_length);
1235 tap->cur_instr = malloc(tap->ir_length);
1236
1237 buf_set_u32(tap->expected, 0, tap->ir_length, tap->ir_capture_value);
1238 buf_set_u32(tap->expected_mask, 0, tap->ir_length, tap->ir_capture_mask);
1239 buf_set_ones(tap->cur_instr, tap->ir_length);
1240
1241 // place TAP in bypass mode
1242 tap->bypass = 1;
1243 // register the reset callback for the TAP
1244 jtag_register_event_callback(&jtag_reset_callback, tap);
1245
1246 LOG_DEBUG("Created Tap: %s @ abs position %d, "
1247 "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1248 tap->abs_chain_position, tap->ir_length,
1249 tap->ir_capture_value, tap->ir_capture_mask);
1250 jtag_tap_add(tap);
1251 }
1252
1253 static void jtag_tap_free(jtag_tap_t *tap)
1254 {
1255 /// @todo is anything missing? no memory leaks please
1256 free((void *)tap->expected_ids);
1257 free((void *)tap->chip);
1258 free((void *)tap->tapname);
1259 free((void *)tap->dotted_name);
1260 free(tap);
1261 }
1262
1263 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1264 {
1265 jtag_tap_t *pTap;
1266 jim_wide w;
1267 int x;
1268 int e;
1269 int reqbits;
1270 Jim_Nvp *n;
1271 char *cp;
1272 const Jim_Nvp opts[] = {
1273 #define NTAP_OPT_IRLEN 0
1274 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1275 #define NTAP_OPT_IRMASK 1
1276 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1277 #define NTAP_OPT_IRCAPTURE 2
1278 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1279 #define NTAP_OPT_ENABLED 3
1280 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1281 #define NTAP_OPT_DISABLED 4
1282 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
1283 #define NTAP_OPT_EXPECTED_ID 5
1284 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
1285 { .name = NULL , .value = -1 },
1286 };
1287
1288 pTap = malloc( sizeof(jtag_tap_t) );
1289 memset( pTap, 0, sizeof(*pTap) );
1290 if( !pTap ){
1291 Jim_SetResult_sprintf( goi->interp, "no memory");
1292 return JIM_ERR;
1293 }
1294 /*
1295 * we expect CHIP + TAP + OPTIONS
1296 * */
1297 if( goi->argc < 3 ){
1298 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
1299 return JIM_ERR;
1300 }
1301 Jim_GetOpt_String( goi, &cp, NULL );
1302 pTap->chip = strdup(cp);
1303
1304 Jim_GetOpt_String( goi, &cp, NULL );
1305 pTap->tapname = strdup(cp);
1306
1307 /* name + dot + name + null */
1308 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
1309 cp = malloc( x );
1310 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
1311 pTap->dotted_name = cp;
1312
1313 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
1314 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
1315
1316 /* default is enabled */
1317 pTap->enabled = 1;
1318
1319 /* deal with options */
1320 #define NTREQ_IRLEN 1
1321 #define NTREQ_IRCAPTURE 2
1322 #define NTREQ_IRMASK 4
1323
1324 /* clear them as we find them */
1325 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
1326
1327 while( goi->argc ){
1328 e = Jim_GetOpt_Nvp( goi, opts, &n );
1329 if( e != JIM_OK ){
1330 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
1331 return e;
1332 }
1333 LOG_DEBUG("Processing option: %s", n->name );
1334 switch( n->value ){
1335 case NTAP_OPT_ENABLED:
1336 pTap->enabled = 1;
1337 break;
1338 case NTAP_OPT_DISABLED:
1339 pTap->enabled = 0;
1340 break;
1341 case NTAP_OPT_EXPECTED_ID:
1342 {
1343 u32 *new_expected_ids;
1344
1345 e = Jim_GetOpt_Wide( goi, &w );
1346 if( e != JIM_OK) {
1347 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
1348 return e;
1349 }
1350
1351 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
1352 if (new_expected_ids == NULL) {
1353 Jim_SetResult_sprintf( goi->interp, "no memory");
1354 return JIM_ERR;
1355 }
1356
1357 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
1358
1359 new_expected_ids[pTap->expected_ids_cnt] = w;
1360
1361 free(pTap->expected_ids);
1362 pTap->expected_ids = new_expected_ids;
1363 pTap->expected_ids_cnt++;
1364 break;
1365 }
1366 case NTAP_OPT_IRLEN:
1367 case NTAP_OPT_IRMASK:
1368 case NTAP_OPT_IRCAPTURE:
1369 e = Jim_GetOpt_Wide( goi, &w );
1370 if( e != JIM_OK ){
1371 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
1372 return e;
1373 }
1374 if( (w < 0) || (w > 0xffff) ){
1375 /* wacky value */
1376 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
1377 n->name, (int)(w), (int)(w));
1378 return JIM_ERR;
1379 }
1380 switch(n->value){
1381 case NTAP_OPT_IRLEN:
1382 pTap->ir_length = w;
1383 reqbits &= (~(NTREQ_IRLEN));
1384 break;
1385 case NTAP_OPT_IRMASK:
1386 pTap->ir_capture_mask = w;
1387 reqbits &= (~(NTREQ_IRMASK));
1388 break;
1389 case NTAP_OPT_IRCAPTURE:
1390 pTap->ir_capture_value = w;
1391 reqbits &= (~(NTREQ_IRCAPTURE));
1392 break;
1393 }
1394 } /* switch(n->value) */
1395 } /* while( goi->argc ) */
1396
1397 /* Did all the required option bits get cleared? */
1398 if (0 == reqbits)
1399 {
1400 jtag_tap_init(pTap);
1401 return ERROR_OK;
1402 }
1403
1404 Jim_SetResult_sprintf(goi->interp,
1405 "newtap: %s missing required parameters",
1406 pTap->dotted_name);
1407 jtag_tap_free(pTap);
1408 return JIM_ERR;
1409 }
1410
1411 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
1412 {
1413 Jim_GetOptInfo goi;
1414 int e;
1415 Jim_Nvp *n;
1416 Jim_Obj *o;
1417 struct command_context_s *context;
1418
1419 enum {
1420 JTAG_CMD_INTERFACE,
1421 JTAG_CMD_INIT_RESET,
1422 JTAG_CMD_NEWTAP,
1423 JTAG_CMD_TAPENABLE,
1424 JTAG_CMD_TAPDISABLE,
1425 JTAG_CMD_TAPISENABLED,
1426 JTAG_CMD_CONFIGURE,
1427 JTAG_CMD_CGET
1428 };
1429
1430 const Jim_Nvp jtag_cmds[] = {
1431 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
1432 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
1433 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
1434 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
1435 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
1436 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
1437 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
1438 { .name = "cget" , .value = JTAG_CMD_CGET },
1439
1440 { .name = NULL, .value = -1 },
1441 };
1442
1443 context = Jim_GetAssocData(interp, "context");
1444 /* go past the command */
1445 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
1446
1447 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
1448 if( e != JIM_OK ){
1449 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
1450 return e;
1451 }
1452 Jim_SetEmptyResult( goi.interp );
1453 switch( n->value ){
1454 case JTAG_CMD_INTERFACE:
1455 /* return the name of the interface */
1456 /* TCL code might need to know the exact type... */
1457 /* FUTURE: we allow this as a means to "set" the interface. */
1458 if( goi.argc != 0 ){
1459 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1460 return JIM_ERR;
1461 }
1462 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
1463 return JIM_OK;
1464 case JTAG_CMD_INIT_RESET:
1465 if( goi.argc != 0 ){
1466 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
1467 return JIM_ERR;
1468 }
1469 e = jtag_init_reset(context);
1470 if( e != ERROR_OK ){
1471 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
1472 return JIM_ERR;
1473 }
1474 return JIM_OK;
1475 case JTAG_CMD_NEWTAP:
1476 return jim_newtap_cmd( &goi );
1477 break;
1478 case JTAG_CMD_TAPISENABLED:
1479 case JTAG_CMD_TAPENABLE:
1480 case JTAG_CMD_TAPDISABLE:
1481 if( goi.argc != 1 ){
1482 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
1483 return JIM_ERR;
1484 }
1485
1486 {
1487 jtag_tap_t *t;
1488 t = jtag_tap_by_jim_obj( goi.interp, goi.argv[0] );
1489 if( t == NULL ){
1490 return JIM_ERR;
1491 }
1492 switch( n->value ){
1493 case JTAG_CMD_TAPISENABLED:
1494 e = t->enabled;
1495 break;
1496 case JTAG_CMD_TAPENABLE:
1497 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
1498 e = 1;
1499 t->enabled = e;
1500 break;
1501 case JTAG_CMD_TAPDISABLE:
1502 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
1503 e = 0;
1504 t->enabled = e;
1505 break;
1506 }
1507 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
1508 return JIM_OK;
1509 }
1510 break;
1511
1512 case JTAG_CMD_CGET:
1513 if( goi.argc < 2 ){
1514 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
1515 return JIM_ERR;
1516 }
1517
1518 {
1519 jtag_tap_t *t;
1520
1521 Jim_GetOpt_Obj(&goi, &o);
1522 t = jtag_tap_by_jim_obj( goi.interp, o );
1523 if( t == NULL ){
1524 return JIM_ERR;
1525 }
1526
1527 goi.isconfigure = 0;
1528 return jtag_tap_configure_cmd( &goi, t);
1529 }
1530 break;
1531
1532 case JTAG_CMD_CONFIGURE:
1533 if( goi.argc < 3 ){
1534 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
1535 return JIM_ERR;
1536 }
1537
1538 {
1539 jtag_tap_t *t;
1540
1541 Jim_GetOpt_Obj(&goi, &o);
1542 t = jtag_tap_by_jim_obj( goi.interp, o );
1543 if( t == NULL ){
1544 return JIM_ERR;
1545 }
1546
1547 goi.isconfigure = 1;
1548 return jtag_tap_configure_cmd( &goi, t);
1549 }
1550 }
1551
1552 return JIM_ERR;
1553 }
1554
1555 int jtag_register_commands(struct command_context_s *cmd_ctx)
1556 {
1557 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
1558
1559 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
1560 COMMAND_CONFIG, "try to configure interface");
1561 register_command(cmd_ctx, NULL,
1562 "interface_list", &handle_interface_list_command,
1563 COMMAND_ANY, "list all built-in interfaces");
1564 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
1565 COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
1566 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
1567 COMMAND_ANY, "set maximum jtag speed (if supported); "
1568 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1569 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
1570 COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
1571 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
1572 COMMAND_ANY,
1573 "[none/trst_only/srst_only/trst_and_srst] [srst_pulls_trst/trst_pulls_srst] [combined/separate] [trst_push_pull/trst_open_drain] [srst_push_pull/srst_open_drain]");
1574 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
1575 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
1576 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
1577 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
1578
1579 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
1580 COMMAND_EXEC, "print current scan chain configuration");
1581
1582 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
1583 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
1584 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
1585 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
1586 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
1587 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
1588 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
1589 register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
1590
1591 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
1592 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
1593 register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
1594 COMMAND_ANY, "verify value capture <enable|disable>");
1595 register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
1596 COMMAND_ANY, "choose short(default) or long tms_sequence <short|long>");
1597 return ERROR_OK;
1598 }
1599
1600 int jtag_interface_init(struct command_context_s *cmd_ctx)
1601 {
1602 if (jtag)
1603 return ERROR_OK;
1604
1605 if (!jtag_interface)
1606 {
1607 /* nothing was previously specified by "interface" command */
1608 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
1609 return ERROR_JTAG_INVALID_INTERFACE;
1610 }
1611 if(hasKHz)
1612 {
1613 jtag_interface->khz(jtag_get_speed_khz(), &jtag_speed);
1614 hasKHz = false;
1615 }
1616
1617 if (jtag_interface->init() != ERROR_OK)
1618 return ERROR_JTAG_INIT_FAILED;
1619
1620 jtag = jtag_interface;
1621 return ERROR_OK;
1622 }
1623
1624 static int jtag_init_inner(struct command_context_s *cmd_ctx)
1625 {
1626 jtag_tap_t *tap;
1627 int retval;
1628
1629 LOG_DEBUG("Init JTAG chain");
1630
1631 tap = jtag_tap_next_enabled(NULL);
1632 if( tap == NULL ){
1633 LOG_ERROR("There are no enabled taps?");
1634 return ERROR_JTAG_INIT_FAILED;
1635 }
1636
1637 jtag_add_tlr();
1638 if ((retval=jtag_execute_queue())!=ERROR_OK)
1639 return retval;
1640
1641 /* examine chain first, as this could discover the real chain layout */
1642 if (jtag_examine_chain() != ERROR_OK)
1643 {
1644 LOG_ERROR("trying to validate configured JTAG chain anyway...");
1645 }
1646
1647 if (jtag_validate_chain() != ERROR_OK)
1648 {
1649 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
1650 }
1651
1652 return ERROR_OK;
1653 }
1654
1655 int jtag_interface_quit(void)
1656 {
1657 if (!jtag || !jtag->quit)
1658 return ERROR_OK;
1659
1660 // close the JTAG interface
1661 int result = jtag->quit();
1662 if (ERROR_OK != result)
1663 LOG_ERROR("failed: %d", result);
1664
1665 return ERROR_OK;
1666 }
1667
1668
1669 int jtag_init_reset(struct command_context_s *cmd_ctx)
1670 {
1671 int retval;
1672
1673 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1674 return retval;
1675
1676 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
1677
1678 /* Reset can happen after a power cycle.
1679 *
1680 * Ideally we would only assert TRST or run RESET before the target reset.
1681 *
1682 * However w/srst_pulls_trst, trst is asserted together with the target
1683 * reset whether we want it or not.
1684 *
1685 * NB! Some targets have JTAG circuitry disabled until a
1686 * trst & srst has been asserted.
1687 *
1688 * NB! here we assume nsrst/ntrst delay are sufficient!
1689 *
1690 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
1691 *
1692 */
1693 jtag_add_reset(1, 0); /* RESET or TRST */
1694 if (jtag_reset_config & RESET_HAS_SRST)
1695 {
1696 jtag_add_reset(1, 1);
1697 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
1698 jtag_add_reset(0, 1);
1699 }
1700 jtag_add_reset(0, 0);
1701 if ((retval = jtag_execute_queue()) != ERROR_OK)
1702 return retval;
1703
1704 /* Check that we can communication on the JTAG chain + eventually we want to
1705 * be able to perform enumeration only after OpenOCD has started
1706 * telnet and GDB server
1707 *
1708 * That would allow users to more easily perform any magic they need to before
1709 * reset happens.
1710 */
1711 return jtag_init_inner(cmd_ctx);
1712 }
1713
1714 int jtag_init(struct command_context_s *cmd_ctx)
1715 {
1716 int retval;
1717 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
1718 return retval;
1719 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
1720 {
1721 return ERROR_OK;
1722 }
1723 return jtag_init_reset(cmd_ctx);
1724 }
1725
1726 void jtag_set_speed_khz(unsigned khz)
1727 {
1728 speed_khz = khz;
1729 }
1730 unsigned jtag_get_speed_khz(void)
1731 {
1732 return speed_khz;
1733 }
1734
1735 static int default_khz(int khz, int *jtag_speed)
1736 {
1737 LOG_ERROR("Translation from khz to jtag_speed not implemented");
1738 return ERROR_FAIL;
1739 }
1740
1741 static int default_speed_div(int speed, int *khz)
1742 {
1743 LOG_ERROR("Translation from jtag_speed to khz not implemented");
1744 return ERROR_FAIL;
1745 }
1746
1747 static int default_power_dropout(int *dropout)
1748 {
1749 *dropout=0; /* by default we can't detect power dropout */
1750 return ERROR_OK;
1751 }
1752
1753 static int default_srst_asserted(int *srst_asserted)
1754 {
1755 *srst_asserted=0; /* by default we can't detect srst asserted */
1756 return ERROR_OK;
1757 }
1758
1759 static int handle_interface_command(struct command_context_s *cmd_ctx,
1760 char *cmd, char **args, int argc)
1761 {
1762 /* check whether the interface is already configured */
1763 if (jtag_interface)
1764 {
1765 LOG_WARNING("Interface already configured, ignoring");
1766 return ERROR_OK;
1767 }
1768
1769 /* interface name is a mandatory argument */
1770 if (argc != 1 || args[0][0] == '\0')
1771 return ERROR_COMMAND_SYNTAX_ERROR;
1772
1773 for (unsigned i = 0; NULL != jtag_interfaces[i]; i++)
1774 {
1775 if (strcmp(args[0], jtag_interfaces[i]->name) != 0)
1776 continue;
1777
1778 int retval = jtag_interfaces[i]->register_commands(cmd_ctx);
1779 if (ERROR_OK != retval)
1780 return retval;
1781
1782 jtag_interface = jtag_interfaces[i];
1783
1784 if (jtag_interface->khz == NULL)
1785 jtag_interface->khz = default_khz;
1786 if (jtag_interface->speed_div == NULL)
1787 jtag_interface->speed_div = default_speed_div;
1788 if (jtag_interface->power_dropout == NULL)
1789 jtag_interface->power_dropout = default_power_dropout;
1790 if (jtag_interface->srst_asserted == NULL)
1791 jtag_interface->srst_asserted = default_srst_asserted;
1792
1793 return ERROR_OK;
1794 }
1795
1796 /* no valid interface was found (i.e. the configuration option,
1797 * didn't match one of the compiled-in interfaces
1798 */
1799 LOG_ERROR("The specified JTAG interface was not found (%s)", args[0]);
1800 handle_interface_list_command(cmd_ctx, cmd, args, argc);
1801 return ERROR_JTAG_INVALID_INTERFACE;
1802 }
1803
1804 static int handle_interface_list_command(struct command_context_s *cmd_ctx,
1805 char *cmd, char **args, int argc)
1806 {
1807 if (strcmp(cmd, "interface_list") == 0 && argc > 0)
1808 return ERROR_COMMAND_SYNTAX_ERROR;
1809
1810 command_print(cmd_ctx, "The following JTAG interfaces are available:");
1811 for (unsigned i = 0; NULL != jtag_interfaces[i]; i++)
1812 {
1813 const char *name = jtag_interfaces[i]->name;
1814 command_print(cmd_ctx, "%u: %s", i + 1, name);
1815 }
1816
1817 return ERROR_OK;
1818 }
1819
1820 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1821 {
1822 int e;
1823 char buf[1024];
1824 Jim_Obj *newargs[ 10 ];
1825 /*
1826 * CONVERT SYNTAX
1827 * argv[-1] = command
1828 * argv[ 0] = ir length
1829 * argv[ 1] = ir capture
1830 * argv[ 2] = ir mask
1831 * argv[ 3] = not actually used by anything but in the docs
1832 */
1833
1834 if( argc < 4 ){
1835 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
1836 return ERROR_OK;
1837 }
1838 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
1839 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
1840 args[0],
1841 args[1],
1842 args[2] );
1843 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
1844 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
1845 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
1846 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
1847
1848 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
1849 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
1850 sprintf( buf, "chip%d", jtag_tap_count() );
1851 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
1852 sprintf( buf, "tap%d", jtag_tap_count() );
1853 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
1854 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
1855 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
1856 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
1857 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
1858 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
1859 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
1860
1861 command_print( cmd_ctx, "NEW COMMAND:");
1862 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
1863 Jim_GetString( newargs[0], NULL ),
1864 Jim_GetString( newargs[1], NULL ),
1865 Jim_GetString( newargs[2], NULL ),
1866 Jim_GetString( newargs[3], NULL ),
1867 Jim_GetString( newargs[4], NULL ),
1868 Jim_GetString( newargs[5], NULL ),
1869 Jim_GetString( newargs[6], NULL ),
1870 Jim_GetString( newargs[7], NULL ),
1871 Jim_GetString( newargs[8], NULL ),
1872 Jim_GetString( newargs[9], NULL ) );
1873
1874 e = jim_jtag_command( interp, 10, newargs );
1875 if( e != JIM_OK ){
1876 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
1877 }
1878 return e;
1879 }
1880
1881 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1882 {
1883 jtag_tap_t *tap;
1884
1885 tap = jtag_all_taps();
1886 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
1887 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
1888
1889 while( tap ){
1890 u32 expected, expected_mask, cur_instr, ii;
1891 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
1892 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
1893 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
1894
1895 command_print(cmd_ctx,
1896 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
1897 tap->abs_chain_position,
1898 tap->dotted_name,
1899 tap->enabled ? 'Y' : 'n',
1900 tap->idcode,
1901 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
1902 tap->ir_length,
1903 expected,
1904 expected_mask,
1905 cur_instr);
1906
1907 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
1908 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
1909 tap->expected_ids[ii]);
1910 }
1911
1912 tap = tap->next_tap;
1913 }
1914
1915 return ERROR_OK;
1916 }
1917
1918 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
1919 {
1920 int new_cfg = 0;
1921 int mask = 0;
1922
1923 if (argc < 1)
1924 return ERROR_COMMAND_SYNTAX_ERROR;
1925
1926 /* Original versions cared about the order of these tokens:
1927 * reset_config signals [combination [trst_type [srst_type]]]
1928 * They also clobbered the previous configuration even on error.
1929 *
1930 * Here we don't care about the order, and only change values
1931 * which have been explicitly specified.
1932 */
1933 for (; argc; argc--, args++) {
1934 int tmp = 0;
1935 int m;
1936
1937 /* signals */
1938 m = RESET_HAS_TRST | RESET_HAS_SRST;
1939 if (strcmp(*args, "none") == 0)
1940 tmp = RESET_NONE;
1941 else if (strcmp(*args, "trst_only") == 0)
1942 tmp = RESET_HAS_TRST;
1943 else if (strcmp(*args, "srst_only") == 0)
1944 tmp = RESET_HAS_SRST;
1945 else if (strcmp(*args, "trst_and_srst") == 0)
1946 tmp = RESET_HAS_TRST | RESET_HAS_SRST;
1947 else
1948 m = 0;
1949 if (mask & m) {
1950 LOG_ERROR("extra reset_config %s spec (%s)",
1951 "signal", *args);
1952 return ERROR_INVALID_ARGUMENTS;
1953 }
1954 if (m)
1955 goto next;
1956
1957 /* combination (options for broken wiring) */
1958 m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
1959 if (strcmp(*args, "separate") == 0)
1960 /* separate reset lines - default */;
1961 else if (strcmp(*args, "srst_pulls_trst") == 0)
1962 tmp |= RESET_SRST_PULLS_TRST;
1963 else if (strcmp(*args, "trst_pulls_srst") == 0)
1964 tmp |= RESET_TRST_PULLS_SRST;
1965 else if (strcmp(*args, "combined") == 0)
1966 tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
1967 else
1968 m = 0;
1969 if (mask & m) {
1970 LOG_ERROR("extra reset_config %s spec (%s)",
1971 "combination", *args);
1972 return ERROR_INVALID_ARGUMENTS;
1973 }
1974 if (m)
1975 goto next;
1976
1977 /* trst_type (NOP without HAS_TRST) */
1978 m = RESET_TRST_OPEN_DRAIN;
1979 if (strcmp(*args, "trst_open_drain") == 0)
1980 tmp |= RESET_TRST_OPEN_DRAIN;
1981 else if (strcmp(*args, "trst_push_pull") == 0)
1982 /* push/pull from adapter - default */;
1983 else
1984 m = 0;
1985 if (mask & m) {
1986 LOG_ERROR("extra reset_config %s spec (%s)",
1987 "trst_type", *args);
1988 return ERROR_INVALID_ARGUMENTS;
1989 }
1990 if (m)
1991 goto next;
1992
1993 /* srst_type (NOP without HAS_SRST) */
1994 m |= RESET_SRST_PUSH_PULL;
1995 if (strcmp(*args, "srst_push_pull") == 0)
1996 tmp |= RESET_SRST_PUSH_PULL;
1997 else if (strcmp(*args, "srst_open_drain") == 0)
1998 /* open drain from adapter - default */;
1999 else
2000 m = 0;
2001 if (mask & m) {
2002 LOG_ERROR("extra reset_config %s spec (%s)",
2003 "srst_type", *args);
2004 return ERROR_INVALID_ARGUMENTS;
2005 }
2006 if (m)
2007 goto next;
2008
2009 /* caller provided nonsense; fail */
2010 LOG_ERROR("unknown reset_config flag (%s)", *args);
2011 return ERROR_INVALID_ARGUMENTS;
2012
2013 next:
2014 /* Remember the bits which were specified (mask)
2015 * and their new values (new_cfg).
2016 */
2017 mask |= m;
2018 new_cfg |= tmp;
2019 }
2020
2021 /* clear previous values of those bits, save new values */
2022 jtag_reset_config &= ~mask;
2023 jtag_reset_config |= new_cfg;
2024
2025 return ERROR_OK;
2026 }
2027
2028 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx,
2029 char *cmd, char **args, int argc)
2030 {
2031 if (argc > 1)
2032 return ERROR_COMMAND_SYNTAX_ERROR;
2033 if (argc == 1)
2034 jtag_set_nsrst_delay(strtoul(args[0], NULL, 0));
2035 command_print(cmd_ctx, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
2036 return ERROR_OK;
2037 }
2038
2039 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx,
2040 char *cmd, char **args, int argc)
2041 {
2042 if (argc > 1)
2043 return ERROR_COMMAND_SYNTAX_ERROR;
2044 if (argc == 1)
2045 jtag_set_ntrst_delay(strtoul(args[0], NULL, 0));
2046 command_print(cmd_ctx, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
2047 return ERROR_OK;
2048 }
2049
2050 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2051 {
2052 int retval = ERROR_OK;
2053
2054 if (argc > 1)
2055 return ERROR_COMMAND_SYNTAX_ERROR;
2056 if (argc == 1)
2057 {
2058 LOG_DEBUG("handle jtag speed");
2059
2060 int cur_speed = 0;
2061 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2062
2063 /* this command can be called during CONFIG,
2064 * in which case jtag isn't initialized */
2065 if (jtag)
2066 retval = jtag->speed(cur_speed);
2067 }
2068 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2069
2070 return retval;
2071 }
2072
2073 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2074 {
2075 if (argc > 1)
2076 return ERROR_COMMAND_SYNTAX_ERROR;
2077
2078 int retval = ERROR_OK;
2079 int cur_speed = 0;
2080 if (argc == 1)
2081 {
2082 LOG_DEBUG("handle jtag khz");
2083
2084 jtag_set_speed_khz(strtoul(args[0], NULL, 0));
2085 if (jtag != NULL)
2086 {
2087 LOG_DEBUG("have interface set up");
2088 int speed_div1;
2089 retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
2090 if (ERROR_OK != retval)
2091 {
2092 jtag_set_speed_khz(0);
2093 return retval;
2094 }
2095 cur_speed = jtag_speed = speed_div1;
2096
2097 retval = jtag->speed(cur_speed);
2098 }
2099 else
2100 hasKHz = true;
2101 }
2102
2103 cur_speed = jtag_get_speed_khz();
2104 if (jtag != NULL)
2105 {
2106 retval = jtag->speed_div(jtag_speed, &cur_speed);
2107 if (ERROR_OK != retval)
2108 return retval;
2109 }
2110
2111 if (cur_speed)
2112 command_print(cmd_ctx, "%d kHz", cur_speed);
2113 else
2114 command_print(cmd_ctx, "RCLK - adaptive");
2115 return retval;
2116
2117 }
2118
2119 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx,
2120 char *cmd, char **args, int argc)
2121 {
2122 if (argc != 2)
2123 return ERROR_COMMAND_SYNTAX_ERROR;
2124
2125 int trst = -1;
2126 if (args[0][0] == '1')
2127 trst = 1;
2128 else if (args[0][0] == '0')
2129 trst = 0;
2130 else
2131 return ERROR_COMMAND_SYNTAX_ERROR;
2132
2133 int srst = -1;
2134 if (args[1][0] == '1')
2135 srst = 1;
2136 else if (args[1][0] == '0')
2137 srst = 0;
2138 else
2139 return ERROR_COMMAND_SYNTAX_ERROR;
2140
2141 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2142 return ERROR_JTAG_INIT_FAILED;
2143
2144 jtag_add_reset(trst, srst);
2145 jtag_execute_queue();
2146
2147 return ERROR_OK;
2148 }
2149
2150 static int handle_runtest_command(struct command_context_s *cmd_ctx,
2151 char *cmd, char **args, int argc)
2152 {
2153 if (argc != 1)
2154 return ERROR_COMMAND_SYNTAX_ERROR;
2155
2156 jtag_add_runtest(strtol(args[0], NULL, 0), jtag_get_end_state());
2157 jtag_execute_queue();
2158
2159 return ERROR_OK;
2160 }
2161
2162 /*
2163 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2164 * should be stable ... and *NOT* a shift state, otherwise free-running
2165 * jtag clocks could change the values latched by the update state.
2166 */
2167 static bool scan_is_safe(tap_state_t state)
2168 {
2169 switch (state)
2170 {
2171 case TAP_RESET:
2172 case TAP_IDLE:
2173 case TAP_DRPAUSE:
2174 case TAP_IRPAUSE:
2175 return true;
2176 default:
2177 return false;
2178 }
2179 }
2180
2181
2182 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2183 {
2184 int i;
2185 scan_field_t *fields;
2186 jtag_tap_t *tap;
2187 tap_state_t endstate;
2188
2189 if ((argc < 2) || (argc % 2))
2190 {
2191 return ERROR_COMMAND_SYNTAX_ERROR;
2192 }
2193
2194 /* optional "-endstate" "statename" at the end of the arguments,
2195 * so that e.g. IRPAUSE can let us load the data register before
2196 * entering RUN/IDLE to execute the instruction we load here.
2197 */
2198 endstate = TAP_IDLE;
2199
2200 if( argc >= 4 ){
2201 /* have at least one pair of numbers. */
2202 /* is last pair the magic text? */
2203 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
2204 const char *cpA;
2205 const char *cpS;
2206 cpA = args[ argc-1 ];
2207 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
2208 cpS = tap_state_name( endstate );
2209 if( 0 == strcmp( cpA, cpS ) ){
2210 break;
2211 }
2212 }
2213 if( endstate >= TAP_NUM_STATES ){
2214 return ERROR_COMMAND_SYNTAX_ERROR;
2215 } else {
2216 if (!scan_is_safe(endstate))
2217 LOG_WARNING("irscan with unsafe "
2218 "endstate \"%s\"", cpA);
2219 /* found - remove the last 2 args */
2220 argc -= 2;
2221 }
2222 }
2223 }
2224
2225 int num_fields = argc / 2;
2226
2227 fields = malloc(sizeof(scan_field_t) * num_fields);
2228
2229 for (i = 0; i < num_fields; i++)
2230 {
2231 tap = jtag_tap_by_string( args[i*2] );
2232 if (tap==NULL)
2233 {
2234 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
2235 return ERROR_FAIL;
2236 }
2237 int field_size = tap->ir_length;
2238 fields[i].tap = tap;
2239 fields[i].num_bits = field_size;
2240 fields[i].out_value = malloc(CEIL(field_size, 8));
2241 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
2242 fields[i].in_value = NULL;
2243 }
2244
2245 /* did we have an endstate? */
2246 jtag_add_ir_scan(num_fields, fields, endstate);
2247
2248 int retval=jtag_execute_queue();
2249
2250 for (i = 0; i < num_fields; i++)
2251 free(fields[i].out_value);
2252
2253 free (fields);
2254
2255 return retval;
2256 }
2257
2258 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2259 {
2260 int retval;
2261 scan_field_t *fields;
2262 int num_fields;
2263 int field_count = 0;
2264 int i, e;
2265 jtag_tap_t *tap;
2266 tap_state_t endstate;
2267
2268 /* args[1] = device
2269 * args[2] = num_bits
2270 * args[3] = hex string
2271 * ... repeat num bits and hex string ...
2272 *
2273 * .. optionally:
2274 * args[N-2] = "-endstate"
2275 * args[N-1] = statename
2276 */
2277 if ((argc < 4) || ((argc % 2)!=0))
2278 {
2279 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
2280 return JIM_ERR;
2281 }
2282
2283 endstate = TAP_IDLE;
2284
2285 /* validate arguments as numbers */
2286 e = JIM_OK;
2287 for (i = 2; i < argc; i+=2)
2288 {
2289 long bits;
2290 const char *cp;
2291
2292 e = Jim_GetLong(interp, args[i], &bits);
2293 /* If valid - try next arg */
2294 if( e == JIM_OK ){
2295 continue;
2296 }
2297
2298 /* Not valid.. are we at the end? */
2299 if ( ((i+2) != argc) ){
2300 /* nope, then error */
2301 return e;
2302 }
2303
2304 /* it could be: "-endstate FOO"
2305 * e.g. DRPAUSE so we can issue more instructions
2306 * before entering RUN/IDLE and executing them.
2307 */
2308
2309 /* get arg as a string. */
2310 cp = Jim_GetString( args[i], NULL );
2311 /* is it the magic? */
2312 if( 0 == strcmp( "-endstate", cp ) ){
2313 /* is the statename valid? */
2314 cp = Jim_GetString( args[i+1], NULL );
2315
2316 /* see if it is a valid state name */
2317 endstate = tap_state_by_name(cp);
2318 if( endstate < 0 ){
2319 /* update the error message */
2320 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
2321 } else {
2322 if (!scan_is_safe(endstate))
2323 LOG_WARNING("drscan with unsafe "
2324 "endstate \"%s\"", cp);
2325
2326 /* valid - so clear the error */
2327 e = JIM_OK;
2328 /* and remove the last 2 args */
2329 argc -= 2;
2330 }
2331 }
2332
2333 /* Still an error? */
2334 if( e != JIM_OK ){
2335 return e; /* too bad */
2336 }
2337 } /* validate args */
2338
2339 tap = jtag_tap_by_jim_obj( interp, args[1] );
2340 if( tap == NULL ){
2341 return JIM_ERR;
2342 }
2343
2344 num_fields=(argc-2)/2;
2345 fields = malloc(sizeof(scan_field_t) * num_fields);
2346 for (i = 2; i < argc; i+=2)
2347 {
2348 long bits;
2349 int len;
2350 const char *str;
2351
2352 Jim_GetLong(interp, args[i], &bits);
2353 str = Jim_GetString(args[i+1], &len);
2354
2355 fields[field_count].tap = tap;
2356 fields[field_count].num_bits = bits;
2357 fields[field_count].out_value = malloc(CEIL(bits, 8));
2358 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
2359 fields[field_count].in_value = fields[field_count].out_value;
2360 field_count++;
2361 }
2362
2363 jtag_add_dr_scan(num_fields, fields, endstate);
2364
2365 retval = jtag_execute_queue();
2366 if (retval != ERROR_OK)
2367 {
2368 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
2369 return JIM_ERR;
2370 }
2371
2372 field_count=0;
2373 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
2374 for (i = 2; i < argc; i+=2)
2375 {
2376 long bits;
2377 char *str;
2378
2379 Jim_GetLong(interp, args[i], &bits);
2380 str = buf_to_str(fields[field_count].in_value, bits, 16);
2381 free(fields[field_count].out_value);
2382
2383 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
2384 free(str);
2385 field_count++;
2386 }
2387
2388 Jim_SetResult(interp, list);
2389
2390 free(fields);
2391
2392 return JIM_OK;
2393 }
2394
2395
2396 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
2397 {
2398 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_get_flush_queue_count()));
2399
2400 return JIM_OK;
2401 }
2402
2403
2404 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2405 {
2406 if (argc == 1)
2407 {
2408 if (strcmp(args[0], "enable") == 0)
2409 {
2410 jtag_verify_capture_ir = 1;
2411 }
2412 else if (strcmp(args[0], "disable") == 0)
2413 {
2414 jtag_verify_capture_ir = 0;
2415 } else
2416 {
2417 return ERROR_COMMAND_SYNTAX_ERROR;
2418 }
2419 } else if (argc != 0)
2420 {
2421 return ERROR_COMMAND_SYNTAX_ERROR;
2422 }
2423
2424 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
2425
2426 return ERROR_OK;
2427 }
2428
2429 void jtag_set_verify(bool enable)
2430 {
2431 jtag_verify = enable;
2432 }
2433
2434 bool jtag_will_verify()
2435 {
2436 return jtag_verify;
2437 }
2438
2439 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2440 {
2441 if (argc > 1)
2442 return ERROR_COMMAND_SYNTAX_ERROR;
2443
2444 if (argc == 1)
2445 {
2446 if (strcmp(args[0], "enable") == 0)
2447 jtag_set_verify(true);
2448 else if (strcmp(args[0], "disable") == 0)
2449 jtag_set_verify(false);
2450 else
2451 return ERROR_COMMAND_SYNTAX_ERROR;
2452 }
2453
2454 const char *status = jtag_will_verify() ? "enabled": "disabled";
2455 command_print(cmd_ctx, "verify jtag capture is %s", status);
2456
2457 return ERROR_OK;
2458 }
2459
2460
2461 int jtag_power_dropout(int *dropout)
2462 {
2463 return jtag->power_dropout(dropout);
2464 }
2465
2466 int jtag_srst_asserted(int *srst_asserted)
2467 {
2468 return jtag->srst_asserted(srst_asserted);
2469 }
2470
2471 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
2472 {
2473 jtag_tap_event_action_t * jteap;
2474 int done;
2475
2476 jteap = tap->event_action;
2477
2478 done = 0;
2479 while (jteap) {
2480 if (jteap->event == e) {
2481 done = 1;
2482 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
2483 tap->dotted_name,
2484 e,
2485 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
2486 Jim_GetString(jteap->body, NULL) );
2487 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
2488 Jim_PrintErrorMessage(interp);
2489 }
2490 }
2491
2492 jteap = jteap->next;
2493 }
2494
2495 if (!done) {
2496 LOG_DEBUG( "event %d %s - no action",
2497 e,
2498 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
2499 }
2500 }
2501
2502 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2503 {
2504 if (argc > 1)
2505 return ERROR_COMMAND_SYNTAX_ERROR;
2506
2507 if (argc == 1)
2508 {
2509 bool use_new_table;
2510 if (strcmp(args[0], "short") == 0)
2511 use_new_table = true;
2512 else if (strcmp(args[0], "long") == 0)
2513 use_new_table = false;
2514 else
2515 return ERROR_COMMAND_SYNTAX_ERROR;
2516
2517 tap_use_new_tms_table(use_new_table);
2518 }
2519
2520 command_print(cmd_ctx, "tms sequence is %s",
2521 tap_uses_new_tms_table() ? "short": "long");
2522
2523 return ERROR_OK;
2524 }
2525
2526 /**
2527 * Moves from the current state to the goal \a state. This needs
2528 * to be handled according to the xsvf spec, see the XSTATE command
2529 * description.
2530 *
2531 * From the XSVF spec, pertaining to XSTATE:
2532 *
2533 * For special states known as stable states (Test-Logic-Reset,
2534 * Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
2535 * predefined TAP state paths when the starting state is a stable state
2536 * and when the XSTATE specifies a new stable state. See the STATE
2537 * command in the [Ref 5] for the TAP state paths between stable
2538 * states.
2539 *
2540 * For non-stable states, XSTATE should specify a state that is only one
2541 * TAP state transition distance from the current TAP state to avoid
2542 * undefined TAP state paths. A sequence of multiple XSTATE commands can
2543 * be issued to transition the TAP through a specific state path.
2544 *
2545 * @note Unless @a tms_bits holds a path that agrees with [Ref 5] in *
2546 * above spec, then this code is not fully conformant to the xsvf spec.
2547 * This puts a burden on tap_get_tms_path() function from the xsvf spec.
2548 * If in doubt, you should confirm that that burden is being met.
2549 *
2550 * Otherwise, state must be immediately reachable in one clock cycle,
2551 * and does not need to be a stable state.
2552 */
2553 int jtag_add_statemove(tap_state_t goal_state)
2554 {
2555 tap_state_t cur_state = cmd_queue_cur_state;
2556
2557 LOG_DEBUG( "cur_state=%s goal_state=%s",
2558 tap_state_name(cur_state),
2559 tap_state_name(goal_state) );
2560
2561
2562 if (goal_state==cur_state )
2563 ; /* nothing to do */
2564 else if( goal_state==TAP_RESET )
2565 {
2566 jtag_add_tlr();
2567 }
2568 else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
2569 {
2570 unsigned tms_bits = tap_get_tms_path(cur_state, goal_state);
2571 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
2572 tap_state_t moves[8];
2573 assert(tms_count < DIM(moves));
2574
2575 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1)
2576 {
2577 bool bit = tms_bits & 1;
2578
2579 cur_state = tap_state_transition(cur_state, bit);
2580 moves[i] = cur_state;
2581 }
2582
2583 jtag_add_pathmove(tms_count, moves);
2584 }
2585 else if( tap_state_transition(cur_state, true) == goal_state
2586 || tap_state_transition(cur_state, false) == goal_state )
2587 {
2588 jtag_add_pathmove(1, &goal_state);
2589 }
2590
2591 else
2592 return ERROR_FAIL;
2593
2594 return ERROR_OK;
2595 }
2596
2597 void jtag_set_nsrst_delay(unsigned delay)
2598 {
2599 jtag_nsrst_delay = delay;
2600 }
2601 unsigned jtag_get_nsrst_delay(void)
2602 {
2603 return jtag_nsrst_delay;
2604 }
2605 void jtag_set_ntrst_delay(unsigned delay)
2606 {
2607 jtag_ntrst_delay = delay;
2608 }
2609 unsigned jtag_get_ntrst_delay(void)
2610 {
2611 return jtag_ntrst_delay;
2612 }
Open On-Chip Debugger

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)