Code Review / openocd.git / blob
? search:


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