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