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