Code Review / openocd.git / blob
? search:


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