Code Review / openocd.git / blob
? search:


682c1b33098685b3ef40082dc82cbc180882e685
[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 #define INCLUDE_JTAG_MINIDRIVER_H
32 #define INCLUDE_JTAG_INTERFACE_H
33 #include "jtag.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 typedef struct cmd_queue_page_s
51 {
52 void *address;
53 size_t used;
54 struct cmd_queue_page_s *next;
55 } cmd_queue_page_t;
56
57 #define CMD_QUEUE_PAGE_SIZE (1024 * 1024)
58 static cmd_queue_page_t *cmd_queue_pages = NULL;
59
60 char* jtag_event_strings[] =
61 {
62 "JTAG controller reset (RESET or TRST)"
63 };
64
65 const Jim_Nvp nvp_jtag_tap_event[] = {
66 { .value = JTAG_TAP_EVENT_ENABLE, .name = "tap-enable" },
67 { .value = JTAG_TAP_EVENT_DISABLE, .name = "tap-disable" },
68
69 { .name = NULL, .value = -1 }
70 };
71
72 int jtag_trst = 0;
73 int jtag_srst = 0;
74
75 #ifndef HAVE_JTAG_MINIDRIVER_H
76 struct jtag_callback_entry
77 {
78 struct jtag_callback_entry *next;
79
80 jtag_callback_t callback;
81 u8 *in;
82 jtag_callback_data_t data1;
83 jtag_callback_data_t data2;
84 jtag_callback_data_t data3;
85 };
86
87
88 static struct jtag_callback_entry *jtag_callback_queue_head = NULL;
89 static struct jtag_callback_entry *jtag_callback_queue_tail = NULL;
90
91 static void jtag_callback_queue_reset(void)
92 {
93 jtag_callback_queue_head = NULL;
94 jtag_callback_queue_tail = NULL;
95 }
96 #endif
97
98
99 jtag_command_t *jtag_command_queue = NULL;
100 static jtag_command_t **next_command_pointer = &jtag_command_queue;
101 static jtag_tap_t *jtag_all_taps = NULL;
102
103 enum reset_types jtag_reset_config = RESET_NONE;
104 tap_state_t cmd_queue_end_state = TAP_RESET;
105 tap_state_t cmd_queue_cur_state = TAP_RESET;
106
107 int jtag_verify_capture_ir = 1;
108 int jtag_verify = 1;
109
110 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
111 static int jtag_nsrst_delay = 0; /* default to no nSRST delay */
112 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
113
114 /* maximum number of JTAG devices expected in the chain
115 */
116 #define JTAG_MAX_CHAIN_SIZE 20
117
118 /* callbacks to inform high-level handlers about JTAG state changes */
119 jtag_event_callback_t *jtag_event_callbacks;
120
121 /* speed in kHz*/
122 static int speed_khz = 0;
123 /* flag if the kHz speed was defined */
124 static int hasKHz = 0;
125
126 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
127 */
128
129 #if BUILD_ECOSBOARD == 1
130 extern jtag_interface_t zy1000_interface;
131 #endif
132
133 #if BUILD_PARPORT == 1
134 extern jtag_interface_t parport_interface;
135 #endif
136
137 #if BUILD_DUMMY == 1
138 extern jtag_interface_t dummy_interface;
139 #endif
140
141 #if BUILD_FT2232_FTD2XX == 1
142 extern jtag_interface_t ft2232_interface;
143 #endif
144
145 #if BUILD_FT2232_LIBFTDI == 1
146 extern jtag_interface_t ft2232_interface;
147 #endif
148
149 #if BUILD_AMTJTAGACCEL == 1
150 extern jtag_interface_t amt_jtagaccel_interface;
151 #endif
152
153 #if BUILD_EP93XX == 1
154 extern jtag_interface_t ep93xx_interface;
155 #endif
156
157 #if BUILD_AT91RM9200 == 1
158 extern jtag_interface_t at91rm9200_interface;
159 #endif
160
161 #if BUILD_GW16012 == 1
162 extern jtag_interface_t gw16012_interface;
163 #endif
164
165 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
166 extern jtag_interface_t presto_interface;
167 #endif
168
169 #if BUILD_USBPROG == 1
170 extern jtag_interface_t usbprog_interface;
171 #endif
172
173 #if BUILD_JLINK == 1
174 extern jtag_interface_t jlink_interface;
175 #endif
176
177 #if BUILD_VSLLINK == 1
178 extern jtag_interface_t vsllink_interface;
179 #endif
180
181 #if BUILD_RLINK == 1
182 extern jtag_interface_t rlink_interface;
183 #endif
184
185 #if BUILD_ARMJTAGEW == 1
186 extern jtag_interface_t armjtagew_interface;
187 #endif
188
189 jtag_interface_t *jtag_interfaces[] = {
190 #if BUILD_ECOSBOARD == 1
191 &zy1000_interface,
192 #endif
193 #if BUILD_PARPORT == 1
194 &parport_interface,
195 #endif
196 #if BUILD_DUMMY == 1
197 &dummy_interface,
198 #endif
199 #if BUILD_FT2232_FTD2XX == 1
200 &ft2232_interface,
201 #endif
202 #if BUILD_FT2232_LIBFTDI == 1
203 &ft2232_interface,
204 #endif
205 #if BUILD_AMTJTAGACCEL == 1
206 &amt_jtagaccel_interface,
207 #endif
208 #if BUILD_EP93XX == 1
209 &ep93xx_interface,
210 #endif
211 #if BUILD_AT91RM9200 == 1
212 &at91rm9200_interface,
213 #endif
214 #if BUILD_GW16012 == 1
215 &gw16012_interface,
216 #endif
217 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
218 &presto_interface,
219 #endif
220 #if BUILD_USBPROG == 1
221 &usbprog_interface,
222 #endif
223 #if BUILD_JLINK == 1
224 &jlink_interface,
225 #endif
226 #if BUILD_VSLLINK == 1
227 &vsllink_interface,
228 #endif
229 #if BUILD_RLINK == 1
230 &rlink_interface,
231 #endif
232 #if BUILD_ARMJTAGEW == 1
233 &armjtagew_interface,
234 #endif
235 NULL,
236 };
237
238 static jtag_interface_t *jtag = NULL;
239
240 /* configuration */
241 static jtag_interface_t *jtag_interface = NULL;
242 int jtag_speed = 0;
243
244 /* forward declarations */
245 //void jtag_add_pathmove(int num_states, tap_state_t *path);
246 //void jtag_add_runtest(int num_cycles, tap_state_t endstate);
247 //void jtag_add_end_state(tap_state_t endstate);
248 //void jtag_add_sleep(u32 us);
249 //int jtag_execute_queue(void);
250 static tap_state_t tap_state_by_name(const char *name);
251
252 /* jtag commands */
253 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
254 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
255 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
256 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
257 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
258 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
259 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
260
261 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
262
263 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
264 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
265 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
266 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
267 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
268 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args);
269
270 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
271 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
272 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
273
274 jtag_tap_t *jtag_AllTaps(void)
275 {
276 return jtag_all_taps;
277 };
278
279 int jtag_NumTotalTaps(void)
280 {
281 jtag_tap_t *t;
282 int n;
283
284 n = 0;
285 t = jtag_AllTaps();
286 while(t){
287 n++;
288 t = t->next_tap;
289 }
290 return n;
291 }
292
293 int jtag_NumEnabledTaps(void)
294 {
295 jtag_tap_t *t;
296 int n;
297
298 n = 0;
299 t = jtag_AllTaps();
300 while(t){
301 if( t->enabled ){
302 n++;
303 }
304 t = t->next_tap;
305 }
306 return n;
307 }
308
309 jtag_tap_t *jtag_TapByString( const char *s )
310 {
311 jtag_tap_t *t;
312 char *cp;
313
314 t = jtag_AllTaps();
315 /* try name first */
316 while(t){
317 if( 0 == strcmp( t->dotted_name, s ) ){
318 break;
319 } else {
320 t = t->next_tap;
321 }
322 }
323 /* backup plan is by number */
324 if( t == NULL ){
325 /* ok - is "s" a number? */
326 int n;
327 n = strtol( s, &cp, 0 );
328 if( (s != cp) && (*cp == 0) ){
329 /* Then it is... */
330 t = jtag_TapByAbsPosition(n);
331 }
332 }
333 return t;
334 }
335
336 jtag_tap_t * jtag_TapByJimObj( Jim_Interp *interp, Jim_Obj *o )
337 {
338 jtag_tap_t *t;
339 const char *cp;
340
341 cp = Jim_GetString( o, NULL );
342 if(cp == NULL){
343 cp = "(unknown)";
344 t = NULL;
345 } else {
346 t = jtag_TapByString( cp );
347 }
348 if( t == NULL ){
349 Jim_SetResult_sprintf(interp,"Tap: %s is unknown", cp );
350 }
351 return t;
352 }
353
354 /* returns a pointer to the n-th device in the scan chain */
355 jtag_tap_t * jtag_TapByAbsPosition( int n )
356 {
357 int orig_n;
358 jtag_tap_t *t;
359
360 orig_n = n;
361 t = jtag_AllTaps();
362
363 while( t && (n > 0)) {
364 n--;
365 t = t->next_tap;
366 }
367 return t;
368 }
369
370 int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv)
371 {
372 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
373
374 if (callback == NULL)
375 {
376 return ERROR_INVALID_ARGUMENTS;
377 }
378
379 if (*callbacks_p)
380 {
381 while ((*callbacks_p)->next)
382 callbacks_p = &((*callbacks_p)->next);
383 callbacks_p = &((*callbacks_p)->next);
384 }
385
386 (*callbacks_p) = malloc(sizeof(jtag_event_callback_t));
387 (*callbacks_p)->callback = callback;
388 (*callbacks_p)->priv = priv;
389 (*callbacks_p)->next = NULL;
390
391 return ERROR_OK;
392 }
393
394 int jtag_unregister_event_callback(int (*callback)(enum jtag_event event, void *priv))
395 {
396 jtag_event_callback_t **callbacks_p = &jtag_event_callbacks;
397
398 if (callback == NULL)
399 {
400 return ERROR_INVALID_ARGUMENTS;
401 }
402
403 while (*callbacks_p)
404 {
405 jtag_event_callback_t **next = &((*callbacks_p)->next);
406 if ((*callbacks_p)->callback == callback)
407 {
408 free(*callbacks_p);
409 *callbacks_p = *next;
410 }
411 callbacks_p = next;
412 }
413
414 return ERROR_OK;
415 }
416
417 int jtag_call_event_callbacks(enum jtag_event event)
418 {
419 jtag_event_callback_t *callback = jtag_event_callbacks;
420
421 LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
422
423 while (callback)
424 {
425 callback->callback(event, callback->priv);
426 callback = callback->next;
427 }
428
429 return ERROR_OK;
430 }
431
432 void jtag_queue_command(jtag_command_t * cmd)
433 {
434 // this command goes on the end, so ensure the queue terminates
435 cmd->next = NULL;
436
437 jtag_command_t **last_cmd = next_command_pointer;
438 assert(NULL != last_cmd);
439 assert(NULL == *last_cmd);
440 *last_cmd = cmd;
441
442 // store location where the next command pointer will be stored
443 next_command_pointer = &cmd->next;
444 }
445
446 void* cmd_queue_alloc(size_t size)
447 {
448 cmd_queue_page_t **p_page = &cmd_queue_pages;
449 int offset;
450 u8 *t;
451
452 /*
453 * WARNING:
454 * We align/round the *SIZE* per below
455 * so that all pointers returned by
456 * this function are reasonably well
457 * aligned.
458 *
459 * If we did not, then an "odd-length" request would cause the
460 * *next* allocation to be at an *odd* address, and because
461 * this function has the same type of api as malloc() - we
462 * must also return pointers that have the same type of
463 * alignment.
464 *
465 * What I do not/have is a reasonable portable means
466 * to align by...
467 *
468 * The solution here, is based on these suggestions.
469 * http://gcc.gnu.org/ml/gcc-help/2008-12/msg00041.html
470 *
471 */
472 union worse_case_align {
473 int i;
474 long l;
475 float f;
476 void *v;
477 };
478 #define ALIGN_SIZE (sizeof(union worse_case_align))
479
480 /* The alignment process. */
481 size = (size + ALIGN_SIZE -1) & (~(ALIGN_SIZE-1));
482 /* Done... */
483
484 if (*p_page)
485 {
486 while ((*p_page)->next)
487 p_page = &((*p_page)->next);
488 if (CMD_QUEUE_PAGE_SIZE - (*p_page)->used < size)
489 p_page = &((*p_page)->next);
490 }
491
492 if (!*p_page)
493 {
494 *p_page = malloc(sizeof(cmd_queue_page_t));
495 (*p_page)->used = 0;
496 (*p_page)->address = malloc(CMD_QUEUE_PAGE_SIZE);
497 (*p_page)->next = NULL;
498 }
499
500 offset = (*p_page)->used;
501 (*p_page)->used += size;
502
503 t=(u8 *)((*p_page)->address);
504 return t + offset;
505 }
506
507 void cmd_queue_free(void)
508 {
509 cmd_queue_page_t *page = cmd_queue_pages;
510
511 while (page)
512 {
513 cmd_queue_page_t *last = page;
514 free(page->address);
515 page = page->next;
516 free(last);
517 }
518
519 cmd_queue_pages = NULL;
520 }
521
522 void jtag_command_queue_reset(void)
523 {
524 cmd_queue_free();
525
526 jtag_command_queue = NULL;
527 next_command_pointer = &jtag_command_queue;
528 }
529
530 /**
531 * Copy a scan_field_t for insertion into the queue.
532 *
533 * This allocates a new copy of out_value using cmd_queue_alloc.
534 */
535 static void cmd_queue_scan_field_clone(scan_field_t * dst, const scan_field_t * src)
536 {
537 dst->tap = src->tap;
538 dst->num_bits = src->num_bits;
539 dst->out_value = buf_cpy(src->out_value, cmd_queue_alloc(CEIL(src->num_bits, 8)), src->num_bits);
540 dst->in_value = src->in_value;
541 }
542
543
544 static void jtag_prelude1(void)
545 {
546 if (jtag_trst == 1)
547 {
548 LOG_WARNING("JTAG command queued, while TRST is low (TAP in reset)");
549 jtag_error=ERROR_JTAG_TRST_ASSERTED;
550 return;
551 }
552
553 if (cmd_queue_end_state == TAP_RESET)
554 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
555 }
556
557 static void jtag_prelude(tap_state_t state)
558 {
559 jtag_prelude1();
560
561 if (state != TAP_INVALID)
562 jtag_add_end_state(state);
563
564 cmd_queue_cur_state = cmd_queue_end_state;
565 }
566
567 void jtag_add_ir_scan_noverify(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
568 {
569 int retval;
570 jtag_prelude(state);
571
572 retval=interface_jtag_add_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
573 if (retval!=ERROR_OK)
574 jtag_error=retval;
575
576 }
577
578
579 /**
580 * Generate an IR SCAN with a list of scan fields with one entry for each enabled TAP.
581 *
582 * If the input field list contains an instruction value for a TAP then that is used
583 * otherwise the TAP is set to bypass.
584 *
585 * TAPs for which no fields are passed are marked as bypassed for subsequent DR SCANs.
586 *
587 */
588 void jtag_add_ir_scan(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
589 {
590 if (jtag_verify&&jtag_verify_capture_ir)
591 {
592 /* 8 x 32 bit id's is enough for all invocations */
593
594 for (int j = 0; j < in_num_fields; j++)
595 {
596 /* if we are to run a verification of the ir scan, we need to get the input back.
597 * We may have to allocate space if the caller didn't ask for the input back.
598 */
599 in_fields[j].check_value=in_fields[j].tap->expected;
600 in_fields[j].check_mask=in_fields[j].tap->expected_mask;
601 }
602 jtag_add_scan_check(jtag_add_ir_scan_noverify, in_num_fields, in_fields, state);
603 } else
604 {
605 jtag_add_ir_scan_noverify(in_num_fields, in_fields, state);
606 }
607 }
608
609 /**
610 * see jtag_add_ir_scan()
611 *
612 */
613 int MINIDRIVER(interface_jtag_add_ir_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
614 {
615 size_t num_taps = jtag_NumEnabledTaps();
616
617 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
618 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
619 scan_field_t * out_fields = cmd_queue_alloc(num_taps * sizeof(scan_field_t));
620
621 jtag_queue_command(cmd);
622
623 cmd->type = JTAG_SCAN;
624 cmd->cmd.scan = scan;
625
626 scan->ir_scan = true;
627 scan->num_fields = num_taps; /* one field per device */
628 scan->fields = out_fields;
629 scan->end_state = state;
630
631
632 scan_field_t * field = out_fields; /* keep track where we insert data */
633
634 /* loop over all enabled TAPs */
635
636 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
637 {
638 /* search the input field list for fields for the current TAP */
639
640 bool found = false;
641
642 for (int j = 0; j < in_num_fields; j++)
643 {
644 if (tap != in_fields[j].tap)
645 continue;
646
647 /* if TAP is listed in input fields, copy the value */
648
649 found = true;
650
651 tap->bypass = 0;
652
653 assert(in_fields[j].num_bits == tap->ir_length); /* input fields must have the same length as the TAP's IR */
654
655 cmd_queue_scan_field_clone(field, in_fields + j);
656
657 break;
658 }
659
660 if (!found)
661 {
662 /* if a TAP isn't listed in input fields, set it to BYPASS */
663
664 tap->bypass = 1;
665
666 field->tap = tap;
667 field->num_bits = tap->ir_length;
668 field->out_value = buf_set_ones(cmd_queue_alloc(CEIL(tap->ir_length, 8)), tap->ir_length);
669 field->in_value = NULL; /* do not collect input for tap's in bypass */
670 }
671
672 /* update device information */
673 buf_cpy(field->out_value, tap->cur_instr, tap->ir_length);
674
675 field++;
676 }
677
678 assert(field == out_fields + num_taps); /* paranoia: jtag_NumEnabledTaps() and jtag_NextEnabledTap() not in sync */
679
680 return ERROR_OK;
681 }
682
683 /**
684 * Duplicate the scan fields passed into the function into an IR SCAN command
685 *
686 * This function assumes that the caller handles extra fields for bypassed TAPs
687 *
688 */
689 void jtag_add_plain_ir_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
690 {
691 int retval;
692
693 jtag_prelude(state);
694
695 retval=interface_jtag_add_plain_ir_scan(in_num_fields, in_fields, cmd_queue_end_state);
696 if (retval!=ERROR_OK)
697 jtag_error=retval;
698 }
699
700
701 /**
702 * see jtag_add_plain_ir_scan()
703 *
704 */
705 int MINIDRIVER(interface_jtag_add_plain_ir_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
706 {
707
708 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
709 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
710 scan_field_t * out_fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
711
712 jtag_queue_command(cmd);
713
714 cmd->type = JTAG_SCAN;
715 cmd->cmd.scan = scan;
716
717 scan->ir_scan = true;
718 scan->num_fields = in_num_fields;
719 scan->fields = out_fields;
720 scan->end_state = state;
721
722 for (int i = 0; i < in_num_fields; i++)
723 cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
724
725 return ERROR_OK;
726 }
727
728
729
730 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits);
731
732 static int jtag_check_value_mask_callback(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
733 {
734 return jtag_check_value_inner(in, (u8 *)data1, (u8 *)data2, (int)data3);
735 }
736
737 #ifdef HAVE_JTAG_MINIDRIVER_H
738 void interface_jtag_add_scan_check_alloc(scan_field_t *field)
739 {
740 /* We're executing this synchronously, so try to use local storage. */
741 if (field->num_bits > 32)
742 {
743 unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
744 field->in_value = (u8 *)malloc(num_bytes);
745 field->allocated = 1;
746 }
747 else
748 field->in_value = field->intmp;
749 }
750 #else
751 void interface_jtag_add_scan_check_alloc(scan_field_t *field)
752 {
753 unsigned num_bytes = TAP_SCAN_BYTES(field->num_bits);
754 field->in_value = (u8 *)cmd_queue_alloc(num_bytes);
755 }
756 #endif
757
758 static void jtag_add_scan_check(void (*jtag_add_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state),
759 int in_num_fields, scan_field_t *in_fields, tap_state_t state)
760 {
761 for (int i = 0; i < in_num_fields; i++)
762 {
763 struct scan_field_s *field = &in_fields[i];
764 field->allocated = 0;
765 field->modified = 0;
766 if (field->check_value || field->in_value)
767 continue;
768 interface_jtag_add_scan_check_alloc(field);
769 field->modified = 1;
770 }
771
772 jtag_add_scan(in_num_fields, in_fields, state);
773
774 for (int i = 0; i < in_num_fields; i++)
775 {
776 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
777 {
778 /* this is synchronous for a minidriver */
779 jtag_add_callback4(jtag_check_value_mask_callback, in_fields[i].in_value,
780 (jtag_callback_data_t)in_fields[i].check_value,
781 (jtag_callback_data_t)in_fields[i].check_mask,
782 (jtag_callback_data_t)in_fields[i].num_bits);
783 }
784 if (in_fields[i].allocated)
785 {
786 free(in_fields[i].in_value);
787 }
788 if (in_fields[i].modified)
789 {
790 in_fields[i].in_value = NULL;
791 }
792 }
793 }
794
795 void jtag_add_dr_scan_check(int in_num_fields, scan_field_t *in_fields, tap_state_t state)
796 {
797 if (jtag_verify)
798 {
799 jtag_add_scan_check(jtag_add_dr_scan, in_num_fields, in_fields, state);
800 } else
801 {
802 jtag_add_dr_scan(in_num_fields, in_fields, state);
803 }
804 }
805
806
807 /**
808 * Generate a DR SCAN using the fields passed to the function
809 *
810 * For not bypassed TAPs the function checks in_fields and uses fields specified there.
811 * For bypassed TAPs the function generates a dummy 1bit field.
812 *
813 * The bypass status of TAPs is set by jtag_add_ir_scan().
814 *
815 */
816 void jtag_add_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
817 {
818 int retval;
819
820 jtag_prelude(state);
821
822 retval=interface_jtag_add_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
823 if (retval!=ERROR_OK)
824 jtag_error=retval;
825 }
826
827
828 /**
829 * see jtag_add_dr_scan()
830 *
831 */
832 int MINIDRIVER(interface_jtag_add_dr_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
833 {
834 /* count devices in bypass */
835
836 size_t bypass_devices = 0;
837
838 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
839 {
840 if (tap->bypass)
841 bypass_devices++;
842 }
843
844 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
845 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
846 scan_field_t * out_fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
847
848 jtag_queue_command(cmd);
849
850 cmd->type = JTAG_SCAN;
851 cmd->cmd.scan = scan;
852
853 scan->ir_scan = false;
854 scan->num_fields = in_num_fields + bypass_devices;
855 scan->fields = out_fields;
856 scan->end_state = state;
857
858
859 scan_field_t * field = out_fields; /* keep track where we insert data */
860
861 /* loop over all enabled TAPs */
862
863 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
864 {
865 /* if TAP is not bypassed insert matching input fields */
866
867 if (!tap->bypass)
868 {
869 scan_field_t * start_field = field; /* keep initial position for assert() */
870
871 for (int j = 0; j < in_num_fields; j++)
872 {
873 if (tap != in_fields[j].tap)
874 continue;
875
876 cmd_queue_scan_field_clone(field, in_fields + j);
877
878 field++;
879 }
880
881 assert(field > start_field); /* must have at least one input field per not bypassed TAP */
882 }
883
884 /* if a TAP is bypassed, generated a dummy bit*/
885 else
886 {
887 field->tap = tap;
888 field->num_bits = 1;
889 field->out_value = NULL;
890 field->in_value = NULL;
891
892 field++;
893 }
894 }
895
896 assert(field == out_fields + scan->num_fields); /* no superfluous input fields permitted */
897
898 return ERROR_OK;
899 }
900
901
902
903 /**
904 * Generate a DR SCAN using the array of output values passed to the function
905 *
906 * This function assumes that the parameter target_tap specifies the one TAP
907 * that is not bypassed. All other TAPs must be bypassed and the function will
908 * generate a dummy 1bit field for them.
909 *
910 * For the target_tap a sequence of output-only fields will be generated where
911 * each field has the size num_bits and the field's values are taken from
912 * the array value.
913 *
914 * The bypass status of TAPs is set by jtag_add_ir_scan().
915 *
916 */
917 void MINIDRIVER(interface_jtag_add_dr_out)(jtag_tap_t *target_tap,
918 int in_num_fields,
919 const int *num_bits,
920 const u32 *value,
921 tap_state_t end_state)
922 {
923 /* count devices in bypass */
924
925 size_t bypass_devices = 0;
926
927 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
928 {
929 if (tap->bypass)
930 bypass_devices++;
931 }
932
933
934 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
935 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
936 scan_field_t * out_fields = cmd_queue_alloc((in_num_fields + bypass_devices) * sizeof(scan_field_t));
937
938 jtag_queue_command(cmd);
939
940 cmd->type = JTAG_SCAN;
941 cmd->cmd.scan = scan;
942
943 scan->ir_scan = false;
944 scan->num_fields = in_num_fields + bypass_devices;
945 scan->fields = out_fields;
946 scan->end_state = end_state;
947
948
949 bool target_tap_match = false;
950
951 scan_field_t * field = out_fields; /* keep track where we insert data */
952
953 /* loop over all enabled TAPs */
954
955 for (jtag_tap_t * tap = jtag_NextEnabledTap(NULL); tap != NULL; tap = jtag_NextEnabledTap(tap))
956 {
957 /* if TAP is not bypassed insert matching input fields */
958
959 if (!tap->bypass)
960 {
961 assert(tap == target_tap); /* target_tap must match the one not bypassed TAP */
962
963 target_tap_match = true;
964
965 for (int j = 0; j < in_num_fields; j++)
966 {
967 u8 out_value[4];
968 size_t scan_size = num_bits[j];
969 buf_set_u32(out_value, 0, scan_size, value[j]);
970
971 field->tap = tap;
972 field->num_bits = scan_size;
973 field->out_value = buf_cpy(out_value, cmd_queue_alloc(CEIL(scan_size, 8)), scan_size);
974 field->in_value = NULL;
975
976 field++;
977 }
978 }
979
980 /* if a TAP is bypassed, generated a dummy bit*/
981 else
982 {
983
984 field->tap = tap;
985 field->num_bits = 1;
986 field->out_value = NULL;
987 field->in_value = NULL;
988
989 field++;
990 }
991 }
992
993 assert(target_tap_match); /* target_tap should be enabled and not bypassed */
994 }
995
996
997 /**
998 * Duplicate the scan fields passed into the function into a DR SCAN command
999 *
1000 * This function assumes that the caller handles extra fields for bypassed TAPs
1001 *
1002 */
1003 void jtag_add_plain_dr_scan(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
1004 {
1005 int retval;
1006
1007 jtag_prelude(state);
1008
1009 retval=interface_jtag_add_plain_dr_scan(in_num_fields, in_fields, cmd_queue_end_state);
1010 if (retval!=ERROR_OK)
1011 jtag_error=retval;
1012 }
1013
1014
1015 /**
1016 * see jtag_add_plain_dr_scan()
1017 *
1018 */
1019 int MINIDRIVER(interface_jtag_add_plain_dr_scan)(int in_num_fields, const scan_field_t *in_fields, tap_state_t state)
1020 {
1021 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1022 scan_command_t * scan = cmd_queue_alloc(sizeof(scan_command_t));
1023 scan_field_t * out_fields = cmd_queue_alloc(in_num_fields * sizeof(scan_field_t));
1024
1025 jtag_queue_command(cmd);
1026
1027 cmd->type = JTAG_SCAN;
1028 cmd->cmd.scan = scan;
1029
1030 scan->ir_scan = false;
1031 scan->num_fields = in_num_fields;
1032 scan->fields = out_fields;
1033 scan->end_state = state;
1034
1035 for (int i = 0; i < in_num_fields; i++)
1036 cmd_queue_scan_field_clone(out_fields + i, in_fields + i);
1037
1038 return ERROR_OK;
1039 }
1040
1041
1042 void jtag_add_tlr(void)
1043 {
1044 jtag_prelude(TAP_RESET);
1045
1046 int retval;
1047 retval=interface_jtag_add_tlr();
1048 if (retval!=ERROR_OK)
1049 jtag_error=retval;
1050 }
1051
1052 int MINIDRIVER(interface_jtag_add_tlr)(void)
1053 {
1054 tap_state_t state = TAP_RESET;
1055
1056 /* allocate memory for a new list member */
1057 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1058
1059 jtag_queue_command(cmd);
1060
1061 cmd->type = JTAG_STATEMOVE;
1062
1063 cmd->cmd.statemove = cmd_queue_alloc(sizeof(statemove_command_t));
1064 cmd->cmd.statemove->end_state = state;
1065
1066 return ERROR_OK;
1067 }
1068
1069 void jtag_add_pathmove(int num_states, const tap_state_t *path)
1070 {
1071 tap_state_t cur_state = cmd_queue_cur_state;
1072 int i;
1073 int retval;
1074
1075 /* the last state has to be a stable state */
1076 if (!tap_is_state_stable(path[num_states - 1]))
1077 {
1078 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
1079 exit(-1);
1080 }
1081
1082 for (i=0; i<num_states; i++)
1083 {
1084 if (path[i] == TAP_RESET)
1085 {
1086 LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
1087 exit(-1);
1088 }
1089
1090 if ( tap_state_transition(cur_state, true) != path[i]
1091 && tap_state_transition(cur_state, false) != path[i])
1092 {
1093 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(cur_state), tap_state_name(path[i]));
1094 exit(-1);
1095 }
1096 cur_state = path[i];
1097 }
1098
1099 jtag_prelude1();
1100
1101 retval = interface_jtag_add_pathmove(num_states, path);
1102 cmd_queue_cur_state = path[num_states - 1];
1103 if (retval!=ERROR_OK)
1104 jtag_error=retval;
1105 }
1106
1107 int MINIDRIVER(interface_jtag_add_pathmove)(int num_states, const tap_state_t *path)
1108 {
1109 /* allocate memory for a new list member */
1110 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1111
1112 jtag_queue_command(cmd);
1113
1114 cmd->type = JTAG_PATHMOVE;
1115
1116 cmd->cmd.pathmove = cmd_queue_alloc(sizeof(pathmove_command_t));
1117 cmd->cmd.pathmove->num_states = num_states;
1118 cmd->cmd.pathmove->path = cmd_queue_alloc(sizeof(tap_state_t) * num_states);
1119
1120 for (int i = 0; i < num_states; i++)
1121 cmd->cmd.pathmove->path[i] = path[i];
1122
1123 return ERROR_OK;
1124 }
1125
1126 int MINIDRIVER(interface_jtag_add_runtest)(int num_cycles, tap_state_t state)
1127 {
1128 /* allocate memory for a new list member */
1129 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1130
1131 jtag_queue_command(cmd);
1132
1133 cmd->type = JTAG_RUNTEST;
1134
1135 cmd->cmd.runtest = cmd_queue_alloc(sizeof(runtest_command_t));
1136 cmd->cmd.runtest->num_cycles = num_cycles;
1137 cmd->cmd.runtest->end_state = state;
1138
1139 return ERROR_OK;
1140 }
1141
1142 void jtag_add_runtest(int num_cycles, tap_state_t state)
1143 {
1144 int retval;
1145
1146 jtag_prelude(state);
1147
1148 /* executed by sw or hw fifo */
1149 retval=interface_jtag_add_runtest(num_cycles, cmd_queue_end_state);
1150 if (retval!=ERROR_OK)
1151 jtag_error=retval;
1152 }
1153
1154
1155 int MINIDRIVER(interface_jtag_add_clocks)( int num_cycles )
1156 {
1157 /* allocate memory for a new list member */
1158 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1159
1160 jtag_queue_command(cmd);
1161
1162 cmd->type = JTAG_STABLECLOCKS;
1163
1164 cmd->cmd.stableclocks = cmd_queue_alloc(sizeof(stableclocks_command_t));
1165 cmd->cmd.stableclocks->num_cycles = num_cycles;
1166
1167 return ERROR_OK;
1168 }
1169
1170 void jtag_add_clocks( int num_cycles )
1171 {
1172 int retval;
1173
1174 if( !tap_is_state_stable(cmd_queue_cur_state) )
1175 {
1176 LOG_ERROR( "jtag_add_clocks() was called with TAP in non-stable state \"%s\"",
1177 tap_state_name(cmd_queue_cur_state) );
1178 jtag_error = ERROR_JTAG_NOT_STABLE_STATE;
1179 return;
1180 }
1181
1182 if( num_cycles > 0 )
1183 {
1184 jtag_prelude1();
1185
1186 retval = interface_jtag_add_clocks(num_cycles);
1187 if (retval != ERROR_OK)
1188 jtag_error=retval;
1189 }
1190 }
1191
1192 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
1193 {
1194 int trst_with_tlr = 0;
1195 int retval;
1196
1197 /* FIX!!! there are *many* different cases here. A better
1198 * approach is needed for legal combinations of transitions...
1199 */
1200 if ((jtag_reset_config & RESET_HAS_SRST)&&
1201 (jtag_reset_config & RESET_HAS_TRST)&&
1202 ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0))
1203 {
1204 if (((req_tlr_or_trst&&!jtag_trst)||
1205 (!req_tlr_or_trst&&jtag_trst))&&
1206 ((req_srst&&!jtag_srst)||
1207 (!req_srst&&jtag_srst)))
1208 {
1209 /* FIX!!! srst_pulls_trst allows 1,1 => 0,0 transition.... */
1210 //LOG_ERROR("BUG: transition of req_tlr_or_trst and req_srst in the same jtag_add_reset() call is undefined");
1211 }
1212 }
1213
1214 /* Make sure that jtag_reset_config allows the requested reset */
1215 /* if SRST pulls TRST, we can't fulfill srst == 1 with trst == 0 */
1216 if (((jtag_reset_config & RESET_SRST_PULLS_TRST) && (req_srst == 1)) && (!req_tlr_or_trst))
1217 {
1218 LOG_ERROR("BUG: requested reset would assert trst");
1219 jtag_error=ERROR_FAIL;
1220 return;
1221 }
1222
1223 /* if TRST pulls SRST, we reset with TAP T-L-R */
1224 if (((jtag_reset_config & RESET_TRST_PULLS_SRST) && (req_tlr_or_trst)) && (req_srst == 0))
1225 {
1226 trst_with_tlr = 1;
1227 }
1228
1229 if (req_srst && !(jtag_reset_config & RESET_HAS_SRST))
1230 {
1231 LOG_ERROR("BUG: requested SRST assertion, but the current configuration doesn't support this");
1232 jtag_error=ERROR_FAIL;
1233 return;
1234 }
1235
1236 if (req_tlr_or_trst)
1237 {
1238 if (!trst_with_tlr && (jtag_reset_config & RESET_HAS_TRST))
1239 {
1240 jtag_trst = 1;
1241 } else
1242 {
1243 trst_with_tlr = 1;
1244 }
1245 } else
1246 {
1247 jtag_trst = 0;
1248 }
1249
1250 jtag_srst = req_srst;
1251
1252 retval = interface_jtag_add_reset(jtag_trst, jtag_srst);
1253 if (retval!=ERROR_OK)
1254 {
1255 jtag_error=retval;
1256 return;
1257 }
1258 jtag_execute_queue();
1259
1260 if (jtag_srst)
1261 {
1262 LOG_DEBUG("SRST line asserted");
1263 }
1264 else
1265 {
1266 LOG_DEBUG("SRST line released");
1267 if (jtag_nsrst_delay)
1268 jtag_add_sleep(jtag_nsrst_delay * 1000);
1269 }
1270
1271 if (trst_with_tlr)
1272 {
1273 LOG_DEBUG("JTAG reset with RESET instead of TRST");
1274 jtag_add_end_state(TAP_RESET);
1275 jtag_add_tlr();
1276 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1277 return;
1278 }
1279
1280 if (jtag_trst)
1281 {
1282 /* we just asserted nTRST, so we're now in Test-Logic-Reset,
1283 * and inform possible listeners about this
1284 */
1285 LOG_DEBUG("TRST line asserted");
1286 tap_set_state(TAP_RESET);
1287 jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
1288 }
1289 else
1290 {
1291 if (jtag_ntrst_delay)
1292 jtag_add_sleep(jtag_ntrst_delay * 1000);
1293 }
1294 }
1295
1296 int MINIDRIVER(interface_jtag_add_reset)(int req_trst, int req_srst)
1297 {
1298 /* allocate memory for a new list member */
1299 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1300
1301 jtag_queue_command(cmd);
1302
1303 cmd->type = JTAG_RESET;
1304
1305 cmd->cmd.reset = cmd_queue_alloc(sizeof(reset_command_t));
1306 cmd->cmd.reset->trst = req_trst;
1307 cmd->cmd.reset->srst = req_srst;
1308
1309 return ERROR_OK;
1310 }
1311
1312 void jtag_add_end_state(tap_state_t state)
1313 {
1314 cmd_queue_end_state = state;
1315 if ((cmd_queue_end_state == TAP_DRSHIFT)||(cmd_queue_end_state == TAP_IRSHIFT))
1316 {
1317 LOG_ERROR("BUG: TAP_DRSHIFT/IRSHIFT can't be end state. Calling code should use a larger scan field");
1318 }
1319 }
1320
1321 int MINIDRIVER(interface_jtag_add_sleep)(u32 us)
1322 {
1323 /* allocate memory for a new list member */
1324 jtag_command_t * cmd = cmd_queue_alloc(sizeof(jtag_command_t));
1325
1326 jtag_queue_command(cmd);
1327
1328 cmd->type = JTAG_SLEEP;
1329
1330 cmd->cmd.sleep = cmd_queue_alloc(sizeof(sleep_command_t));
1331 cmd->cmd.sleep->us = us;
1332
1333 return ERROR_OK;
1334 }
1335
1336 void jtag_add_sleep(u32 us)
1337 {
1338 keep_alive(); /* we might be running on a very slow JTAG clk */
1339 int retval=interface_jtag_add_sleep(us);
1340 if (retval!=ERROR_OK)
1341 jtag_error=retval;
1342 return;
1343 }
1344
1345 int jtag_scan_size(const scan_command_t *cmd)
1346 {
1347 int bit_count = 0;
1348 int i;
1349
1350 /* count bits in scan command */
1351 for (i = 0; i < cmd->num_fields; i++)
1352 {
1353 bit_count += cmd->fields[i].num_bits;
1354 }
1355
1356 return bit_count;
1357 }
1358
1359 int jtag_build_buffer(const scan_command_t *cmd, u8 **buffer)
1360 {
1361 int bit_count = 0;
1362 int i;
1363
1364 bit_count = jtag_scan_size(cmd);
1365 *buffer = calloc(1,CEIL(bit_count, 8));
1366
1367 bit_count = 0;
1368
1369 #ifdef _DEBUG_JTAG_IO_
1370 LOG_DEBUG("%s num_fields: %i", cmd->ir_scan ? "IRSCAN" : "DRSCAN", cmd->num_fields);
1371 #endif
1372
1373 for (i = 0; i < cmd->num_fields; i++)
1374 {
1375 if (cmd->fields[i].out_value)
1376 {
1377 #ifdef _DEBUG_JTAG_IO_
1378 char* char_buf = buf_to_str(cmd->fields[i].out_value, (cmd->fields[i].num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : cmd->fields[i].num_bits, 16);
1379 #endif
1380 buf_set_buf(cmd->fields[i].out_value, 0, *buffer, bit_count, cmd->fields[i].num_bits);
1381 #ifdef _DEBUG_JTAG_IO_
1382 LOG_DEBUG("fields[%i].out_value[%i]: 0x%s", i, cmd->fields[i].num_bits, char_buf);
1383 free(char_buf);
1384 #endif
1385 }
1386 else
1387 {
1388 #ifdef _DEBUG_JTAG_IO_
1389 LOG_DEBUG("fields[%i].out_value[%i]: NULL", i, cmd->fields[i].num_bits);
1390 #endif
1391 }
1392
1393 bit_count += cmd->fields[i].num_bits;
1394 }
1395
1396 #ifdef _DEBUG_JTAG_IO_
1397 //LOG_DEBUG("bit_count totalling: %i", bit_count );
1398 #endif
1399
1400 return bit_count;
1401 }
1402
1403 int jtag_read_buffer(u8 *buffer, const scan_command_t *cmd)
1404 {
1405 int i;
1406 int bit_count = 0;
1407 int retval;
1408
1409 /* we return ERROR_OK, unless a check fails, or a handler reports a problem */
1410 retval = ERROR_OK;
1411
1412 for (i = 0; i < cmd->num_fields; i++)
1413 {
1414 /* if neither in_value nor in_handler
1415 * are specified we don't have to examine this field
1416 */
1417 if (cmd->fields[i].in_value)
1418 {
1419 int num_bits = cmd->fields[i].num_bits;
1420 u8 *captured = buf_set_buf(buffer, bit_count, malloc(CEIL(num_bits, 8)), 0, num_bits);
1421
1422 #ifdef _DEBUG_JTAG_IO_
1423 char *char_buf = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1424 LOG_DEBUG("fields[%i].in_value[%i]: 0x%s", i, num_bits, char_buf);
1425 free(char_buf);
1426 #endif
1427
1428 if (cmd->fields[i].in_value)
1429 {
1430 buf_cpy(captured, cmd->fields[i].in_value, num_bits);
1431 }
1432
1433 free(captured);
1434 }
1435 bit_count += cmd->fields[i].num_bits;
1436 }
1437
1438 return retval;
1439 }
1440
1441 static const char *jtag_tap_name(const jtag_tap_t *tap)
1442 {
1443 return (tap == NULL) ? "(unknown)" : tap->dotted_name;
1444 }
1445
1446 int jtag_check_value_inner(u8 *captured, u8 *in_check_value, u8 *in_check_mask, int num_bits)
1447 {
1448 int retval = ERROR_OK;
1449
1450 int compare_failed = 0;
1451
1452 if (in_check_mask)
1453 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
1454 else
1455 compare_failed = buf_cmp(captured, in_check_value, num_bits);
1456
1457 if (compare_failed){
1458 /* An error handler could have caught the failing check
1459 * only report a problem when there wasn't a handler, or if the handler
1460 * acknowledged the error
1461 */
1462 /*
1463 LOG_WARNING("TAP %s:",
1464 jtag_tap_name(field->tap));
1465 */
1466 if (compare_failed)
1467 {
1468 char *captured_char = buf_to_str(captured, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1469 char *in_check_value_char = buf_to_str(in_check_value, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1470
1471 if (in_check_mask)
1472 {
1473 char *in_check_mask_char;
1474 in_check_mask_char = buf_to_str(in_check_mask, (num_bits > DEBUG_JTAG_IOZ) ? DEBUG_JTAG_IOZ : num_bits, 16);
1475 LOG_WARNING("value captured during scan didn't pass the requested check:");
1476 LOG_WARNING("captured: 0x%s check_value: 0x%s check_mask: 0x%s",
1477 captured_char, in_check_value_char, in_check_mask_char);
1478 free(in_check_mask_char);
1479 }
1480 else
1481 {
1482 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);
1483 }
1484
1485 free(captured_char);
1486 free(in_check_value_char);
1487
1488 retval = ERROR_JTAG_QUEUE_FAILED;
1489 }
1490
1491 }
1492 return retval;
1493 }
1494
1495 void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask)
1496 {
1497 assert(field->in_value != NULL);
1498
1499 if (value==NULL)
1500 {
1501 /* no checking to do */
1502 return;
1503 }
1504
1505 jtag_execute_queue_noclear();
1506
1507 int retval=jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
1508 jtag_set_error(retval);
1509 }
1510
1511
1512
1513 enum scan_type jtag_scan_type(const scan_command_t *cmd)
1514 {
1515 int i;
1516 int type = 0;
1517
1518 for (i = 0; i < cmd->num_fields; i++)
1519 {
1520 if (cmd->fields[i].in_value)
1521 type |= SCAN_IN;
1522 if (cmd->fields[i].out_value)
1523 type |= SCAN_OUT;
1524 }
1525
1526 return type;
1527 }
1528
1529
1530 #ifndef HAVE_JTAG_MINIDRIVER_H
1531 /* add callback to end of queue */
1532 void jtag_add_callback4(jtag_callback_t callback, u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
1533 {
1534 struct jtag_callback_entry *entry=cmd_queue_alloc(sizeof(struct jtag_callback_entry));
1535
1536 entry->next=NULL;
1537 entry->callback=callback;
1538 entry->in=in;
1539 entry->data1=data1;
1540 entry->data2=data2;
1541 entry->data3=data3;
1542
1543 if (jtag_callback_queue_head==NULL)
1544 {
1545 jtag_callback_queue_head=entry;
1546 jtag_callback_queue_tail=entry;
1547 } else
1548 {
1549 jtag_callback_queue_tail->next=entry;
1550 jtag_callback_queue_tail=entry;
1551 }
1552 }
1553
1554
1555 static int jtag_convert_to_callback4(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
1556 {
1557 ((jtag_callback1_t)data1)(in);
1558 return ERROR_OK;
1559 }
1560
1561 void jtag_add_callback(jtag_callback1_t callback, u8 *in)
1562 {
1563 jtag_add_callback4(jtag_convert_to_callback4, in, (jtag_callback_data_t)callback, 0, 0);
1564 }
1565 #endif
1566
1567 #ifndef HAVE_JTAG_MINIDRIVER_H
1568
1569 int interface_jtag_execute_queue(void)
1570 {
1571 int retval = default_interface_jtag_execute_queue();
1572 if (retval == ERROR_OK)
1573 {
1574 struct jtag_callback_entry *entry;
1575 for (entry=jtag_callback_queue_head; entry!=NULL; entry=entry->next)
1576 {
1577 retval=entry->callback(entry->in, entry->data1, entry->data2, entry->data3);
1578 if (retval!=ERROR_OK)
1579 break;
1580 }
1581 }
1582
1583 jtag_command_queue_reset();
1584 jtag_callback_queue_reset();
1585
1586 return retval;
1587 }
1588 #endif
1589
1590 int default_interface_jtag_execute_queue(void)
1591 {
1592 if (NULL == jtag)
1593 {
1594 LOG_ERROR("No JTAG interface configured yet. "
1595 "Issue 'init' command in startup scripts "
1596 "before communicating with targets.");
1597 return ERROR_FAIL;
1598 }
1599
1600 return jtag->execute_queue();
1601 }
1602
1603 void jtag_execute_queue_noclear(void)
1604 {
1605 /* each flush can take as much as 1-2ms on high bandwidth low latency interfaces.
1606 * E.g. a JTAG over TCP/IP or USB....
1607 */
1608 jtag_flush_queue_count++;
1609
1610 int retval=interface_jtag_execute_queue();
1611 /* we keep the first error */
1612 if ((jtag_error==ERROR_OK)&&(retval!=ERROR_OK))
1613 {
1614 jtag_error=retval;
1615 }
1616 }
1617
1618 int jtag_execute_queue(void)
1619 {
1620 int retval;
1621 jtag_execute_queue_noclear();
1622 retval=jtag_error;
1623 jtag_error=ERROR_OK;
1624 return retval;
1625 }
1626
1627 int jtag_reset_callback(enum jtag_event event, void *priv)
1628 {
1629 jtag_tap_t *tap = priv;
1630
1631 LOG_DEBUG("-");
1632
1633 if (event == JTAG_TRST_ASSERTED)
1634 {
1635 buf_set_ones(tap->cur_instr, tap->ir_length);
1636 tap->bypass = 1;
1637 }
1638
1639 return ERROR_OK;
1640 }
1641
1642 void jtag_sleep(u32 us)
1643 {
1644 alive_sleep(us/1000);
1645 }
1646
1647 /* Try to examine chain layout according to IEEE 1149.1 §12
1648 */
1649 int jtag_examine_chain(void)
1650 {
1651 jtag_tap_t *tap;
1652 scan_field_t field;
1653 u8 idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1654 int i;
1655 int bit_count;
1656 int device_count = 0;
1657 u8 zero_check = 0x0;
1658 u8 one_check = 0xff;
1659
1660 field.tap = NULL;
1661 field.num_bits = sizeof(idcode_buffer) * 8;
1662 field.out_value = idcode_buffer;
1663
1664 field.in_value = idcode_buffer;
1665
1666
1667
1668
1669 for (i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
1670 {
1671 buf_set_u32(idcode_buffer, i * 32, 32, 0x000000FF);
1672 }
1673
1674 jtag_add_plain_dr_scan(1, &field, TAP_RESET);
1675 jtag_execute_queue();
1676
1677 for (i = 0; i < JTAG_MAX_CHAIN_SIZE * 4; i++)
1678 {
1679 zero_check |= idcode_buffer[i];
1680 one_check &= idcode_buffer[i];
1681 }
1682
1683 /* if there wasn't a single non-zero bit or if all bits were one, the scan isn't valid */
1684 if ((zero_check == 0x00) || (one_check == 0xff))
1685 {
1686 LOG_ERROR("JTAG communication failure, check connection, JTAG interface, target power etc.");
1687 return ERROR_JTAG_INIT_FAILED;
1688 }
1689
1690 /* point at the 1st tap */
1691 tap = jtag_NextEnabledTap(NULL);
1692 if( tap == NULL ){
1693 LOG_ERROR("JTAG: No taps enabled?");
1694 return ERROR_JTAG_INIT_FAILED;
1695 }
1696
1697 for (bit_count = 0; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;)
1698 {
1699 u32 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1700 if ((idcode & 1) == 0)
1701 {
1702 /* LSB must not be 0, this indicates a device in bypass */
1703 LOG_WARNING("Tap/Device does not have IDCODE");
1704 idcode=0;
1705
1706 bit_count += 1;
1707 }
1708 else
1709 {
1710 u32 manufacturer;
1711 u32 part;
1712 u32 version;
1713
1714 /* some devices, such as AVR will output all 1's instead of TDI
1715 input value at end of chain. */
1716 if ((idcode == 0x000000FF)||(idcode == 0xFFFFFFFF))
1717 {
1718 int unexpected=0;
1719 /* End of chain (invalid manufacturer ID)
1720 *
1721 * The JTAG examine is the very first thing that happens
1722 *
1723 * A single JTAG device requires only 64 bits to be read back correctly.
1724 *
1725 * The code below adds a check that the rest of the data scanned (640 bits)
1726 * are all as expected. This helps diagnose/catch problems with the JTAG chain
1727 *
1728 * earlier and gives more helpful/explicit error messages.
1729 */
1730 for (bit_count += 32; bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;bit_count += 32)
1731 {
1732 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1733 if (unexpected||((idcode != 0x000000FF)&&(idcode != 0xFFFFFFFF)))
1734 {
1735 LOG_WARNING("Unexpected idcode after end of chain! %d 0x%08x", bit_count, idcode);
1736 unexpected = 1;
1737 }
1738 }
1739
1740 break;
1741 }
1742
1743 #define EXTRACT_MFG(X) (((X) & 0xffe) >> 1)
1744 manufacturer = EXTRACT_MFG(idcode);
1745 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
1746 part = EXTRACT_PART(idcode);
1747 #define EXTRACT_VER(X) (((X) & 0xf0000000) >> 28)
1748 version = EXTRACT_VER(idcode);
1749
1750 LOG_INFO("JTAG tap: %s tap/device found: 0x%8.8x (Manufacturer: 0x%3.3x, Part: 0x%4.4x, Version: 0x%1.1x)",
1751 ((tap != NULL) ? (tap->dotted_name) : "(not-named)"),
1752 idcode, manufacturer, part, version);
1753
1754 bit_count += 32;
1755 }
1756 if (tap)
1757 {
1758 tap->idcode = idcode;
1759
1760 if (tap->expected_ids_cnt > 0) {
1761 /* Loop over the expected identification codes and test for a match */
1762 u8 ii;
1763 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1764 if( tap->idcode == tap->expected_ids[ii] ){
1765 break;
1766 }
1767 }
1768
1769 /* If none of the expected ids matched, log an error */
1770 if (ii == tap->expected_ids_cnt) {
1771 LOG_ERROR("JTAG tap: %s got: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1772 tap->dotted_name,
1773 idcode,
1774 EXTRACT_MFG( tap->idcode ),
1775 EXTRACT_PART( tap->idcode ),
1776 EXTRACT_VER( tap->idcode ) );
1777 for (ii = 0; ii < tap->expected_ids_cnt; ii++) {
1778 LOG_ERROR("JTAG tap: %s expected %hhu of %hhu: 0x%08x (mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
1779 tap->dotted_name,
1780 ii + 1,
1781 tap->expected_ids_cnt,
1782 tap->expected_ids[ii],
1783 EXTRACT_MFG( tap->expected_ids[ii] ),
1784 EXTRACT_PART( tap->expected_ids[ii] ),
1785 EXTRACT_VER( tap->expected_ids[ii] ) );
1786 }
1787
1788 return ERROR_JTAG_INIT_FAILED;
1789 } else {
1790 LOG_INFO("JTAG Tap/device matched");
1791 }
1792 } else {
1793 #if 0
1794 LOG_INFO("JTAG TAP ID: 0x%08x - Unknown - please report (A) chipname and (B) idcode to the openocd project",
1795 tap->idcode);
1796 #endif
1797 }
1798 tap = jtag_NextEnabledTap(tap);
1799 }
1800 device_count++;
1801 }
1802
1803 /* see if number of discovered devices matches configuration */
1804 if (device_count != jtag_NumEnabledTaps())
1805 {
1806 LOG_ERROR("number of discovered devices in JTAG chain (%i) doesn't match (enabled) configuration (%i), total taps: %d",
1807 device_count, jtag_NumEnabledTaps(), jtag_NumTotalTaps());
1808 LOG_ERROR("check the config file and ensure proper JTAG communication (connections, speed, ...)");
1809 return ERROR_JTAG_INIT_FAILED;
1810 }
1811
1812 return ERROR_OK;
1813 }
1814
1815 int jtag_validate_chain(void)
1816 {
1817 jtag_tap_t *tap;
1818 int total_ir_length = 0;
1819 u8 *ir_test = NULL;
1820 scan_field_t field;
1821 int chain_pos = 0;
1822
1823 tap = NULL;
1824 total_ir_length = 0;
1825 for(;;){
1826 tap = jtag_NextEnabledTap(tap);
1827 if( tap == NULL ){
1828 break;
1829 }
1830 total_ir_length += tap->ir_length;
1831 }
1832
1833 total_ir_length += 2;
1834 ir_test = malloc(CEIL(total_ir_length, 8));
1835 buf_set_ones(ir_test, total_ir_length);
1836
1837 field.tap = NULL;
1838 field.num_bits = total_ir_length;
1839 field.out_value = ir_test;
1840 field.in_value = ir_test;
1841
1842
1843 jtag_add_plain_ir_scan(1, &field, TAP_RESET);
1844 jtag_execute_queue();
1845
1846 tap = NULL;
1847 chain_pos = 0;
1848 int val;
1849 for(;;){
1850 tap = jtag_NextEnabledTap(tap);
1851 if( tap == NULL ){
1852 break;
1853 }
1854
1855 val = buf_get_u32(ir_test, chain_pos, 2);
1856 if (val != 0x1)
1857 {
1858 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1859 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);
1860 free(cbuf);
1861 free(ir_test);
1862 return ERROR_JTAG_INIT_FAILED;
1863 }
1864 chain_pos += tap->ir_length;
1865 }
1866
1867 val = buf_get_u32(ir_test, chain_pos, 2);
1868 if (val != 0x3)
1869 {
1870 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1871 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);
1872 free(cbuf);
1873 free(ir_test);
1874 return ERROR_JTAG_INIT_FAILED;
1875 }
1876
1877 free(ir_test);
1878
1879 return ERROR_OK;
1880 }
1881
1882 enum jtag_tap_cfg_param {
1883 JCFG_EVENT
1884 };
1885
1886 static Jim_Nvp nvp_config_opts[] = {
1887 { .name = "-event", .value = JCFG_EVENT },
1888
1889 { .name = NULL, .value = -1 }
1890 };
1891
1892 static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap)
1893 {
1894 Jim_Nvp *n;
1895 Jim_Obj *o;
1896 int e;
1897
1898 /* parse config or cget options */
1899 while (goi->argc > 0) {
1900 Jim_SetEmptyResult (goi->interp);
1901
1902 e = Jim_GetOpt_Nvp(goi, nvp_config_opts, &n);
1903 if (e != JIM_OK) {
1904 Jim_GetOpt_NvpUnknown(goi, nvp_config_opts, 0);
1905 return e;
1906 }
1907
1908 switch (n->value) {
1909 case JCFG_EVENT:
1910 if (goi->argc == 0) {
1911 Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." );
1912 return JIM_ERR;
1913 }
1914
1915 e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n );
1916 if (e != JIM_OK) {
1917 Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1);
1918 return e;
1919 }
1920
1921 if (goi->isconfigure) {
1922 if (goi->argc != 1) {
1923 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ?EVENT-BODY?");
1924 return JIM_ERR;
1925 }
1926 } else {
1927 if (goi->argc != 0) {
1928 Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name?");
1929 return JIM_ERR;
1930 }
1931 }
1932
1933 {
1934 jtag_tap_event_action_t *jteap;
1935
1936 jteap = tap->event_action;
1937 /* replace existing? */
1938 while (jteap) {
1939 if (jteap->event == (enum jtag_tap_event)n->value) {
1940 break;
1941 }
1942 jteap = jteap->next;
1943 }
1944
1945 if (goi->isconfigure) {
1946 if (jteap == NULL) {
1947 /* create new */
1948 jteap = calloc(1, sizeof (*jteap));
1949 }
1950 jteap->event = n->value;
1951 Jim_GetOpt_Obj( goi, &o);
1952 if (jteap->body) {
1953 Jim_DecrRefCount(interp, jteap->body);
1954 }
1955 jteap->body = Jim_DuplicateObj(goi->interp, o);
1956 Jim_IncrRefCount(jteap->body);
1957
1958 /* add to head of event list */
1959 jteap->next = tap->event_action;
1960 tap->event_action = jteap;
1961 Jim_SetEmptyResult(goi->interp);
1962 } else {
1963 /* get */
1964 if (jteap == NULL) {
1965 Jim_SetEmptyResult(goi->interp);
1966 } else {
1967 Jim_SetResult(goi->interp, Jim_DuplicateObj(goi->interp, jteap->body));
1968 }
1969 }
1970 }
1971 /* loop for more */
1972 break;
1973 }
1974 } /* while (goi->argc) */
1975
1976 return JIM_OK;
1977 }
1978
1979 static int jim_newtap_cmd( Jim_GetOptInfo *goi )
1980 {
1981 jtag_tap_t *pTap;
1982 jtag_tap_t **ppTap;
1983 jim_wide w;
1984 int x;
1985 int e;
1986 int reqbits;
1987 Jim_Nvp *n;
1988 char *cp;
1989 const Jim_Nvp opts[] = {
1990 #define NTAP_OPT_IRLEN 0
1991 { .name = "-irlen" , .value = NTAP_OPT_IRLEN },
1992 #define NTAP_OPT_IRMASK 1
1993 { .name = "-irmask" , .value = NTAP_OPT_IRMASK },
1994 #define NTAP_OPT_IRCAPTURE 2
1995 { .name = "-ircapture" , .value = NTAP_OPT_IRCAPTURE },
1996 #define NTAP_OPT_ENABLED 3
1997 { .name = "-enable" , .value = NTAP_OPT_ENABLED },
1998 #define NTAP_OPT_DISABLED 4
1999 { .name = "-disable" , .value = NTAP_OPT_DISABLED },
2000 #define NTAP_OPT_EXPECTED_ID 5
2001 { .name = "-expected-id" , .value = NTAP_OPT_EXPECTED_ID },
2002 { .name = NULL , .value = -1 },
2003 };
2004
2005 pTap = malloc( sizeof(jtag_tap_t) );
2006 memset( pTap, 0, sizeof(*pTap) );
2007 if( !pTap ){
2008 Jim_SetResult_sprintf( goi->interp, "no memory");
2009 return JIM_ERR;
2010 }
2011 /*
2012 * we expect CHIP + TAP + OPTIONS
2013 * */
2014 if( goi->argc < 3 ){
2015 Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ....");
2016 return JIM_ERR;
2017 }
2018 Jim_GetOpt_String( goi, &cp, NULL );
2019 pTap->chip = strdup(cp);
2020
2021 Jim_GetOpt_String( goi, &cp, NULL );
2022 pTap->tapname = strdup(cp);
2023
2024 /* name + dot + name + null */
2025 x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1;
2026 cp = malloc( x );
2027 sprintf( cp, "%s.%s", pTap->chip, pTap->tapname );
2028 pTap->dotted_name = cp;
2029
2030 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
2031 pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc);
2032
2033 /* default is enabled */
2034 pTap->enabled = 1;
2035
2036 /* deal with options */
2037 #define NTREQ_IRLEN 1
2038 #define NTREQ_IRCAPTURE 2
2039 #define NTREQ_IRMASK 4
2040
2041 /* clear them as we find them */
2042 reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK);
2043
2044 while( goi->argc ){
2045 e = Jim_GetOpt_Nvp( goi, opts, &n );
2046 if( e != JIM_OK ){
2047 Jim_GetOpt_NvpUnknown( goi, opts, 0 );
2048 return e;
2049 }
2050 LOG_DEBUG("Processing option: %s", n->name );
2051 switch( n->value ){
2052 case NTAP_OPT_ENABLED:
2053 pTap->enabled = 1;
2054 break;
2055 case NTAP_OPT_DISABLED:
2056 pTap->enabled = 0;
2057 break;
2058 case NTAP_OPT_EXPECTED_ID:
2059 {
2060 u32 *new_expected_ids;
2061
2062 e = Jim_GetOpt_Wide( goi, &w );
2063 if( e != JIM_OK) {
2064 Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name);
2065 return e;
2066 }
2067
2068 new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1));
2069 if (new_expected_ids == NULL) {
2070 Jim_SetResult_sprintf( goi->interp, "no memory");
2071 return JIM_ERR;
2072 }
2073
2074 memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt);
2075
2076 new_expected_ids[pTap->expected_ids_cnt] = w;
2077
2078 free(pTap->expected_ids);
2079 pTap->expected_ids = new_expected_ids;
2080 pTap->expected_ids_cnt++;
2081 break;
2082 }
2083 case NTAP_OPT_IRLEN:
2084 case NTAP_OPT_IRMASK:
2085 case NTAP_OPT_IRCAPTURE:
2086 e = Jim_GetOpt_Wide( goi, &w );
2087 if( e != JIM_OK ){
2088 Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name );
2089 return e;
2090 }
2091 if( (w < 0) || (w > 0xffff) ){
2092 /* wacky value */
2093 Jim_SetResult_sprintf( goi->interp, "option: %s - wacky value: %d (0x%x)",
2094 n->name, (int)(w), (int)(w));
2095 return JIM_ERR;
2096 }
2097 switch(n->value){
2098 case NTAP_OPT_IRLEN:
2099 pTap->ir_length = w;
2100 reqbits &= (~(NTREQ_IRLEN));
2101 break;
2102 case NTAP_OPT_IRMASK:
2103 pTap->ir_capture_mask = w;
2104 reqbits &= (~(NTREQ_IRMASK));
2105 break;
2106 case NTAP_OPT_IRCAPTURE:
2107 pTap->ir_capture_value = w;
2108 reqbits &= (~(NTREQ_IRCAPTURE));
2109 break;
2110 }
2111 } /* switch(n->value) */
2112 } /* while( goi->argc ) */
2113
2114 /* Did we get all the options? */
2115 if( reqbits ){
2116 // no
2117 Jim_SetResult_sprintf( goi->interp,
2118 "newtap: %s missing required parameters",
2119 pTap->dotted_name);
2120 /* TODO: Tell user what is missing :-( */
2121 /* no memory leaks pelase */
2122 free(((void *)(pTap->expected_ids)));
2123 free(((void *)(pTap->chip)));
2124 free(((void *)(pTap->tapname)));
2125 free(((void *)(pTap->dotted_name)));
2126 free(((void *)(pTap)));
2127 return JIM_ERR;
2128 }
2129
2130 pTap->expected = malloc( pTap->ir_length );
2131 pTap->expected_mask = malloc( pTap->ir_length );
2132 pTap->cur_instr = malloc( pTap->ir_length );
2133
2134 buf_set_u32( pTap->expected,
2135 0,
2136 pTap->ir_length,
2137 pTap->ir_capture_value );
2138 buf_set_u32( pTap->expected_mask,
2139 0,
2140 pTap->ir_length,
2141 pTap->ir_capture_mask );
2142 buf_set_ones( pTap->cur_instr,
2143 pTap->ir_length );
2144
2145 pTap->bypass = 1;
2146
2147 jtag_register_event_callback(jtag_reset_callback, pTap );
2148
2149 ppTap = &(jtag_all_taps);
2150 while( (*ppTap) != NULL ){
2151 ppTap = &((*ppTap)->next_tap);
2152 }
2153 *ppTap = pTap;
2154 {
2155 static int n_taps = 0;
2156 pTap->abs_chain_position = n_taps++;
2157 }
2158 LOG_DEBUG( "Created Tap: %s @ abs position %d, irlen %d, capture: 0x%x mask: 0x%x",
2159 (*ppTap)->dotted_name,
2160 (*ppTap)->abs_chain_position,
2161 (*ppTap)->ir_length,
2162 (*ppTap)->ir_capture_value,
2163 (*ppTap)->ir_capture_mask );
2164
2165 return ERROR_OK;
2166 }
2167
2168 static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv )
2169 {
2170 Jim_GetOptInfo goi;
2171 int e;
2172 Jim_Nvp *n;
2173 Jim_Obj *o;
2174 struct command_context_s *context;
2175
2176 enum {
2177 JTAG_CMD_INTERFACE,
2178 JTAG_CMD_INIT_RESET,
2179 JTAG_CMD_NEWTAP,
2180 JTAG_CMD_TAPENABLE,
2181 JTAG_CMD_TAPDISABLE,
2182 JTAG_CMD_TAPISENABLED,
2183 JTAG_CMD_CONFIGURE,
2184 JTAG_CMD_CGET
2185 };
2186
2187 const Jim_Nvp jtag_cmds[] = {
2188 { .name = "interface" , .value = JTAG_CMD_INTERFACE },
2189 { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET },
2190 { .name = "newtap" , .value = JTAG_CMD_NEWTAP },
2191 { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED },
2192 { .name = "tapenable" , .value = JTAG_CMD_TAPENABLE },
2193 { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE },
2194 { .name = "configure" , .value = JTAG_CMD_CONFIGURE },
2195 { .name = "cget" , .value = JTAG_CMD_CGET },
2196
2197 { .name = NULL, .value = -1 },
2198 };
2199
2200 context = Jim_GetAssocData(interp, "context");
2201 /* go past the command */
2202 Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 );
2203
2204 e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n );
2205 if( e != JIM_OK ){
2206 Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 );
2207 return e;
2208 }
2209 Jim_SetEmptyResult( goi.interp );
2210 switch( n->value ){
2211 case JTAG_CMD_INTERFACE:
2212 /* return the name of the interface */
2213 /* TCL code might need to know the exact type... */
2214 /* FUTURE: we allow this as a means to "set" the interface. */
2215 if( goi.argc != 0 ){
2216 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2217 return JIM_ERR;
2218 }
2219 Jim_SetResultString( goi.interp, jtag_interface->name, -1 );
2220 return JIM_OK;
2221 case JTAG_CMD_INIT_RESET:
2222 if( goi.argc != 0 ){
2223 Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)");
2224 return JIM_ERR;
2225 }
2226 e = jtag_init_reset(context);
2227 if( e != ERROR_OK ){
2228 Jim_SetResult_sprintf( goi.interp, "error: %d", e);
2229 return JIM_ERR;
2230 }
2231 return JIM_OK;
2232 case JTAG_CMD_NEWTAP:
2233 return jim_newtap_cmd( &goi );
2234 break;
2235 case JTAG_CMD_TAPISENABLED:
2236 case JTAG_CMD_TAPENABLE:
2237 case JTAG_CMD_TAPDISABLE:
2238 if( goi.argc != 1 ){
2239 Jim_SetResultString( goi.interp, "Too many parameters",-1 );
2240 return JIM_ERR;
2241 }
2242
2243 {
2244 jtag_tap_t *t;
2245 t = jtag_TapByJimObj( goi.interp, goi.argv[0] );
2246 if( t == NULL ){
2247 return JIM_ERR;
2248 }
2249 switch( n->value ){
2250 case JTAG_CMD_TAPISENABLED:
2251 e = t->enabled;
2252 break;
2253 case JTAG_CMD_TAPENABLE:
2254 jtag_tap_handle_event( t, JTAG_TAP_EVENT_ENABLE);
2255 e = 1;
2256 t->enabled = e;
2257 break;
2258 case JTAG_CMD_TAPDISABLE:
2259 jtag_tap_handle_event( t, JTAG_TAP_EVENT_DISABLE);
2260 e = 0;
2261 t->enabled = e;
2262 break;
2263 }
2264 Jim_SetResult( goi.interp, Jim_NewIntObj( goi.interp, e ) );
2265 return JIM_OK;
2266 }
2267 break;
2268
2269 case JTAG_CMD_CGET:
2270 if( goi.argc < 2 ){
2271 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ...");
2272 return JIM_ERR;
2273 }
2274
2275 {
2276 jtag_tap_t *t;
2277
2278 Jim_GetOpt_Obj(&goi, &o);
2279 t = jtag_TapByJimObj( goi.interp, o );
2280 if( t == NULL ){
2281 return JIM_ERR;
2282 }
2283
2284 goi.isconfigure = 0;
2285 return jtag_tap_configure_cmd( &goi, t);
2286 }
2287 break;
2288
2289 case JTAG_CMD_CONFIGURE:
2290 if( goi.argc < 3 ){
2291 Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ...");
2292 return JIM_ERR;
2293 }
2294
2295 {
2296 jtag_tap_t *t;
2297
2298 Jim_GetOpt_Obj(&goi, &o);
2299 t = jtag_TapByJimObj( goi.interp, o );
2300 if( t == NULL ){
2301 return JIM_ERR;
2302 }
2303
2304 goi.isconfigure = 1;
2305 return jtag_tap_configure_cmd( &goi, t);
2306 }
2307 }
2308
2309 return JIM_ERR;
2310 }
2311
2312 int jtag_register_commands(struct command_context_s *cmd_ctx)
2313 {
2314 register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions");
2315
2316 register_command(cmd_ctx, NULL, "interface", handle_interface_command,
2317 COMMAND_CONFIG, "try to configure interface");
2318 register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command,
2319 COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)");
2320 register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command,
2321 COMMAND_ANY, "set maximum jtag speed (if supported); "
2322 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
2323 register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command,
2324 COMMAND_CONFIG, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
2325 register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command,
2326 COMMAND_ANY,
2327 "[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]");
2328 register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command,
2329 COMMAND_ANY, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
2330 register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command,
2331 COMMAND_ANY, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
2332
2333 register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command,
2334 COMMAND_EXEC, "print current scan chain configuration");
2335
2336 register_command(cmd_ctx, NULL, "endstate", handle_endstate_command,
2337 COMMAND_EXEC, "finish JTAG operations in <tap_state>");
2338 register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command,
2339 COMMAND_EXEC, "toggle reset lines <trst> <srst>");
2340 register_command(cmd_ctx, NULL, "runtest", handle_runtest_command,
2341 COMMAND_EXEC, "move to Run-Test/Idle, and execute <num_cycles>");
2342 register_command(cmd_ctx, NULL, "irscan", handle_irscan_command,
2343 COMMAND_EXEC, "execute IR scan <device> <instr> [dev2] [instr2] ...");
2344 register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
2345 register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed");
2346
2347 register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command,
2348 COMMAND_ANY, "verify value captured during Capture-IR <enable|disable>");
2349 register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command,
2350 COMMAND_ANY, "verify value capture <enable|disable>");
2351 register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command,
2352 COMMAND_ANY, "choose short(default) or long tms_sequence <short|long>");
2353 return ERROR_OK;
2354 }
2355
2356 int jtag_interface_init(struct command_context_s *cmd_ctx)
2357 {
2358 if (jtag)
2359 return ERROR_OK;
2360
2361 if (!jtag_interface)
2362 {
2363 /* nothing was previously specified by "interface" command */
2364 LOG_ERROR("JTAG interface has to be specified, see \"interface\" command");
2365 return ERROR_JTAG_INVALID_INTERFACE;
2366 }
2367 if(hasKHz)
2368 {
2369 jtag_interface->khz(speed_khz, &jtag_speed);
2370 hasKHz = 0;
2371 }
2372
2373 if (jtag_interface->init() != ERROR_OK)
2374 return ERROR_JTAG_INIT_FAILED;
2375
2376 jtag = jtag_interface;
2377 return ERROR_OK;
2378 }
2379
2380 static int jtag_init_inner(struct command_context_s *cmd_ctx)
2381 {
2382 jtag_tap_t *tap;
2383 int retval;
2384
2385 LOG_DEBUG("Init JTAG chain");
2386
2387 tap = jtag_NextEnabledTap(NULL);
2388 if( tap == NULL ){
2389 LOG_ERROR("There are no enabled taps?");
2390 return ERROR_JTAG_INIT_FAILED;
2391 }
2392
2393 jtag_add_tlr();
2394 if ((retval=jtag_execute_queue())!=ERROR_OK)
2395 return retval;
2396
2397 /* examine chain first, as this could discover the real chain layout */
2398 if (jtag_examine_chain() != ERROR_OK)
2399 {
2400 LOG_ERROR("trying to validate configured JTAG chain anyway...");
2401 }
2402
2403 if (jtag_validate_chain() != ERROR_OK)
2404 {
2405 LOG_WARNING("Could not validate JTAG chain, continuing anyway...");
2406 }
2407
2408 return ERROR_OK;
2409 }
2410
2411 int jtag_interface_quit(void)
2412 {
2413 if (!jtag || !jtag->quit)
2414 return ERROR_OK;
2415
2416 // close the JTAG interface
2417 int result = jtag->quit();
2418 if (ERROR_OK != result)
2419 LOG_ERROR("failed: %d", result);
2420
2421 return ERROR_OK;
2422 }
2423
2424
2425 int jtag_init_reset(struct command_context_s *cmd_ctx)
2426 {
2427 int retval;
2428
2429 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2430 return retval;
2431
2432 LOG_DEBUG("Trying to bring the JTAG controller to life by asserting TRST / RESET");
2433
2434 /* Reset can happen after a power cycle.
2435 *
2436 * Ideally we would only assert TRST or run RESET before the target reset.
2437 *
2438 * However w/srst_pulls_trst, trst is asserted together with the target
2439 * reset whether we want it or not.
2440 *
2441 * NB! Some targets have JTAG circuitry disabled until a
2442 * trst & srst has been asserted.
2443 *
2444 * NB! here we assume nsrst/ntrst delay are sufficient!
2445 *
2446 * NB! order matters!!!! srst *can* disconnect JTAG circuitry
2447 *
2448 */
2449 jtag_add_reset(1, 0); /* RESET or TRST */
2450 if (jtag_reset_config & RESET_HAS_SRST)
2451 {
2452 jtag_add_reset(1, 1);
2453 if ((jtag_reset_config & RESET_SRST_PULLS_TRST)==0)
2454 jtag_add_reset(0, 1);
2455 }
2456 jtag_add_reset(0, 0);
2457 if ((retval = jtag_execute_queue()) != ERROR_OK)
2458 return retval;
2459
2460 /* Check that we can communication on the JTAG chain + eventually we want to
2461 * be able to perform enumeration only after OpenOCD has started
2462 * telnet and GDB server
2463 *
2464 * That would allow users to more easily perform any magic they need to before
2465 * reset happens.
2466 */
2467 return jtag_init_inner(cmd_ctx);
2468 }
2469
2470 int jtag_init(struct command_context_s *cmd_ctx)
2471 {
2472 int retval;
2473 if ((retval=jtag_interface_init(cmd_ctx)) != ERROR_OK)
2474 return retval;
2475 if (jtag_init_inner(cmd_ctx)==ERROR_OK)
2476 {
2477 return ERROR_OK;
2478 }
2479 return jtag_init_reset(cmd_ctx);
2480 }
2481
2482 static int default_khz(int khz, int *jtag_speed)
2483 {
2484 LOG_ERROR("Translation from khz to jtag_speed not implemented");
2485 return ERROR_FAIL;
2486 }
2487
2488 static int default_speed_div(int speed, int *khz)
2489 {
2490 LOG_ERROR("Translation from jtag_speed to khz not implemented");
2491 return ERROR_FAIL;
2492 }
2493
2494 static int default_power_dropout(int *dropout)
2495 {
2496 *dropout=0; /* by default we can't detect power dropout */
2497 return ERROR_OK;
2498 }
2499
2500 static int default_srst_asserted(int *srst_asserted)
2501 {
2502 *srst_asserted=0; /* by default we can't detect srst asserted */
2503 return ERROR_OK;
2504 }
2505
2506 static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2507 {
2508 int i;
2509 int retval;
2510
2511 /* check whether the interface is already configured */
2512 if (jtag_interface)
2513 {
2514 LOG_WARNING("Interface already configured, ignoring");
2515 return ERROR_OK;
2516 }
2517
2518 /* interface name is a mandatory argument */
2519 if (argc < 1 || args[0][0] == '\0')
2520 {
2521 return ERROR_COMMAND_SYNTAX_ERROR;
2522 }
2523
2524 for (i=0; jtag_interfaces[i]; i++)
2525 {
2526 if (strcmp(args[0], jtag_interfaces[i]->name) == 0)
2527 {
2528 if ((retval = jtag_interfaces[i]->register_commands(cmd_ctx)) != ERROR_OK)
2529 {
2530 return retval;
2531 }
2532
2533 jtag_interface = jtag_interfaces[i];
2534
2535 if (jtag_interface->khz == NULL)
2536 {
2537 jtag_interface->khz = default_khz;
2538 }
2539 if (jtag_interface->speed_div == NULL)
2540 {
2541 jtag_interface->speed_div = default_speed_div;
2542 }
2543 if (jtag_interface->power_dropout == NULL)
2544 {
2545 jtag_interface->power_dropout = default_power_dropout;
2546 }
2547 if (jtag_interface->srst_asserted == NULL)
2548 {
2549 jtag_interface->srst_asserted = default_srst_asserted;
2550 }
2551
2552 return ERROR_OK;
2553 }
2554 }
2555
2556 /* no valid interface was found (i.e. the configuration option,
2557 * didn't match one of the compiled-in interfaces
2558 */
2559 LOG_ERROR("No valid jtag interface found (%s)", args[0]);
2560 LOG_ERROR("compiled-in jtag interfaces:");
2561 for (i = 0; jtag_interfaces[i]; i++)
2562 {
2563 LOG_ERROR("%i: %s", i, jtag_interfaces[i]->name);
2564 }
2565
2566 return ERROR_JTAG_INVALID_INTERFACE;
2567 }
2568
2569 static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2570 {
2571 int e;
2572 char buf[1024];
2573 Jim_Obj *newargs[ 10 ];
2574 /*
2575 * CONVERT SYNTAX
2576 * argv[-1] = command
2577 * argv[ 0] = ir length
2578 * argv[ 1] = ir capture
2579 * argv[ 2] = ir mask
2580 * argv[ 3] = not actually used by anything but in the docs
2581 */
2582
2583 if( argc < 4 ){
2584 command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
2585 return ERROR_OK;
2586 }
2587 command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax");
2588 command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
2589 args[0],
2590 args[1],
2591 args[2] );
2592 command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
2593 command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
2594 command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
2595 command_print( cmd_ctx, "And then refer to the taps by the dotted name.");
2596
2597 newargs[0] = Jim_NewStringObj( interp, "jtag", -1 );
2598 newargs[1] = Jim_NewStringObj( interp, "newtap", -1 );
2599 sprintf( buf, "chip%d", jtag_NumTotalTaps() );
2600 newargs[2] = Jim_NewStringObj( interp, buf, -1 );
2601 sprintf( buf, "tap%d", jtag_NumTotalTaps() );
2602 newargs[3] = Jim_NewStringObj( interp, buf, -1 );
2603 newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 );
2604 newargs[5] = Jim_NewStringObj( interp, args[0], -1 );
2605 newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 );
2606 newargs[7] = Jim_NewStringObj( interp, args[1], -1 );
2607 newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 );
2608 newargs[9] = Jim_NewStringObj( interp, args[2], -1 );
2609
2610 command_print( cmd_ctx, "NEW COMMAND:");
2611 sprintf( buf, "%s %s %s %s %s %s %s %s %s %s",
2612 Jim_GetString( newargs[0], NULL ),
2613 Jim_GetString( newargs[1], NULL ),
2614 Jim_GetString( newargs[2], NULL ),
2615 Jim_GetString( newargs[3], NULL ),
2616 Jim_GetString( newargs[4], NULL ),
2617 Jim_GetString( newargs[5], NULL ),
2618 Jim_GetString( newargs[6], NULL ),
2619 Jim_GetString( newargs[7], NULL ),
2620 Jim_GetString( newargs[8], NULL ),
2621 Jim_GetString( newargs[9], NULL ) );
2622
2623 e = jim_jtag_command( interp, 10, newargs );
2624 if( e != JIM_OK ){
2625 command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) );
2626 }
2627 return e;
2628 }
2629
2630 static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2631 {
2632 jtag_tap_t *tap;
2633
2634 tap = jtag_all_taps;
2635 command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
2636 command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------");
2637
2638 while( tap ){
2639 u32 expected, expected_mask, cur_instr, ii;
2640 expected = buf_get_u32(tap->expected, 0, tap->ir_length);
2641 expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
2642 cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length);
2643
2644 command_print(cmd_ctx,
2645 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
2646 tap->abs_chain_position,
2647 tap->dotted_name,
2648 tap->enabled ? 'Y' : 'n',
2649 tap->idcode,
2650 (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0),
2651 tap->ir_length,
2652 expected,
2653 expected_mask,
2654 cur_instr);
2655
2656 for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
2657 command_print(cmd_ctx, " | | | | 0x%08x | | | | ",
2658 tap->expected_ids[ii]);
2659 }
2660
2661 tap = tap->next_tap;
2662 }
2663
2664 return ERROR_OK;
2665 }
2666
2667 static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2668 {
2669 int new_cfg = 0;
2670 int mask = 0;
2671
2672 if (argc < 1)
2673 return ERROR_COMMAND_SYNTAX_ERROR;
2674
2675 /* Original versions cared about the order of these tokens:
2676 * reset_config signals [combination [trst_type [srst_type]]]
2677 * They also clobbered the previous configuration even on error.
2678 *
2679 * Here we don't care about the order, and only change values
2680 * which have been explicitly specified.
2681 */
2682 for (; argc; argc--, args++) {
2683 int tmp = 0;
2684 int m;
2685
2686 /* signals */
2687 m = RESET_HAS_TRST | RESET_HAS_SRST;
2688 if (strcmp(*args, "none") == 0)
2689 tmp = RESET_NONE;
2690 else if (strcmp(*args, "trst_only") == 0)
2691 tmp = RESET_HAS_TRST;
2692 else if (strcmp(*args, "srst_only") == 0)
2693 tmp = RESET_HAS_SRST;
2694 else if (strcmp(*args, "trst_and_srst") == 0)
2695 tmp = RESET_HAS_TRST | RESET_HAS_SRST;
2696 else
2697 m = 0;
2698 if (mask & m) {
2699 LOG_ERROR("extra reset_config %s spec (%s)",
2700 "signal", *args);
2701 return ERROR_INVALID_ARGUMENTS;
2702 }
2703 if (m)
2704 goto next;
2705
2706 /* combination (options for broken wiring) */
2707 m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2708 if (strcmp(*args, "separate") == 0)
2709 /* separate reset lines - default */;
2710 else if (strcmp(*args, "srst_pulls_trst") == 0)
2711 tmp |= RESET_SRST_PULLS_TRST;
2712 else if (strcmp(*args, "trst_pulls_srst") == 0)
2713 tmp |= RESET_TRST_PULLS_SRST;
2714 else if (strcmp(*args, "combined") == 0)
2715 tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST;
2716 else
2717 m = 0;
2718 if (mask & m) {
2719 LOG_ERROR("extra reset_config %s spec (%s)",
2720 "combination", *args);
2721 return ERROR_INVALID_ARGUMENTS;
2722 }
2723 if (m)
2724 goto next;
2725
2726 /* trst_type (NOP without HAS_TRST) */
2727 m = RESET_TRST_OPEN_DRAIN;
2728 if (strcmp(*args, "trst_open_drain") == 0)
2729 tmp |= RESET_TRST_OPEN_DRAIN;
2730 else if (strcmp(*args, "trst_push_pull") == 0)
2731 /* push/pull from adapter - default */;
2732 else
2733 m = 0;
2734 if (mask & m) {
2735 LOG_ERROR("extra reset_config %s spec (%s)",
2736 "trst_type", *args);
2737 return ERROR_INVALID_ARGUMENTS;
2738 }
2739 if (m)
2740 goto next;
2741
2742 /* srst_type (NOP without HAS_SRST) */
2743 m |= RESET_SRST_PUSH_PULL;
2744 if (strcmp(*args, "srst_push_pull") == 0)
2745 tmp |= RESET_SRST_PUSH_PULL;
2746 else if (strcmp(*args, "srst_open_drain") == 0)
2747 /* open drain from adapter - default */;
2748 else
2749 m = 0;
2750 if (mask & m) {
2751 LOG_ERROR("extra reset_config %s spec (%s)",
2752 "srst_type", *args);
2753 return ERROR_INVALID_ARGUMENTS;
2754 }
2755 if (m)
2756 goto next;
2757
2758 /* caller provided nonsense; fail */
2759 LOG_ERROR("unknown reset_config flag (%s)", *args);
2760 return ERROR_INVALID_ARGUMENTS;
2761
2762 next:
2763 /* Remember the bits which were specified (mask)
2764 * and their new values (new_cfg).
2765 */
2766 mask |= m;
2767 new_cfg |= tmp;
2768 }
2769
2770 /* clear previous values of those bits, save new values */
2771 jtag_reset_config &= ~mask;
2772 jtag_reset_config |= new_cfg;
2773
2774 return ERROR_OK;
2775 }
2776
2777 static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2778 {
2779 if (argc < 1)
2780 {
2781 LOG_ERROR("jtag_nsrst_delay <ms> command takes one required argument");
2782 exit(-1);
2783 }
2784 else
2785 {
2786 jtag_nsrst_delay = strtoul(args[0], NULL, 0);
2787 }
2788
2789 return ERROR_OK;
2790 }
2791
2792 static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2793 {
2794 if (argc < 1)
2795 {
2796 LOG_ERROR("jtag_ntrst_delay <ms> command takes one required argument");
2797 exit(-1);
2798 }
2799 else
2800 {
2801 jtag_ntrst_delay = strtoul(args[0], NULL, 0);
2802 }
2803
2804 return ERROR_OK;
2805 }
2806
2807 static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2808 {
2809 int retval=ERROR_OK;
2810
2811 if (argc == 1)
2812 {
2813 LOG_DEBUG("handle jtag speed");
2814
2815 int cur_speed = 0;
2816 cur_speed = jtag_speed = strtoul(args[0], NULL, 0);
2817
2818 /* this command can be called during CONFIG,
2819 * in which case jtag isn't initialized */
2820 if (jtag)
2821 {
2822 retval=jtag->speed(cur_speed);
2823 }
2824 } else if (argc == 0)
2825 {
2826 } else
2827 {
2828 return ERROR_COMMAND_SYNTAX_ERROR;
2829 }
2830 command_print(cmd_ctx, "jtag_speed: %d", jtag_speed);
2831
2832 return retval;
2833 }
2834
2835 static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2836 {
2837 int retval=ERROR_OK;
2838 LOG_DEBUG("handle jtag khz");
2839
2840 if(argc == 1)
2841 {
2842 speed_khz = strtoul(args[0], NULL, 0);
2843 if (jtag != NULL)
2844 {
2845 int cur_speed = 0;
2846 LOG_DEBUG("have interface set up");
2847 int speed_div1;
2848 if ((retval=jtag->khz(speed_khz, &speed_div1))!=ERROR_OK)
2849 {
2850 speed_khz = 0;
2851 return retval;
2852 }
2853
2854 cur_speed = jtag_speed = speed_div1;
2855
2856 retval=jtag->speed(cur_speed);
2857 } else
2858 {
2859 hasKHz = 1;
2860 }
2861 } else if (argc==0)
2862 {
2863 } else
2864 {
2865 return ERROR_COMMAND_SYNTAX_ERROR;
2866 }
2867
2868 if (jtag!=NULL)
2869 {
2870 if ((retval=jtag->speed_div(jtag_speed, &speed_khz))!=ERROR_OK)
2871 return retval;
2872 }
2873
2874 if (speed_khz==0)
2875 {
2876 command_print(cmd_ctx, "RCLK - adaptive");
2877 } else
2878 {
2879 command_print(cmd_ctx, "%d kHz", speed_khz);
2880 }
2881 return retval;
2882
2883 }
2884
2885 static int handle_endstate_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2886 {
2887 tap_state_t state;
2888
2889 if (argc < 1)
2890 {
2891 return ERROR_COMMAND_SYNTAX_ERROR;
2892 }
2893 else
2894 {
2895 state = tap_state_by_name( args[0] );
2896 if( state < 0 ){
2897 command_print( cmd_ctx, "Invalid state name: %s\n", args[0] );
2898 return ERROR_COMMAND_SYNTAX_ERROR;
2899 }
2900 jtag_add_end_state(state);
2901 jtag_execute_queue();
2902 }
2903 command_print(cmd_ctx, "current endstate: %s", tap_state_name(cmd_queue_end_state));
2904
2905 return ERROR_OK;
2906 }
2907
2908 static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2909 {
2910 int trst = -1;
2911 int srst = -1;
2912
2913 if (argc < 2)
2914 {
2915 return ERROR_COMMAND_SYNTAX_ERROR;
2916 }
2917
2918 if (args[0][0] == '1')
2919 trst = 1;
2920 else if (args[0][0] == '0')
2921 trst = 0;
2922 else
2923 {
2924 return ERROR_COMMAND_SYNTAX_ERROR;
2925 }
2926
2927 if (args[1][0] == '1')
2928 srst = 1;
2929 else if (args[1][0] == '0')
2930 srst = 0;
2931 else
2932 {
2933 return ERROR_COMMAND_SYNTAX_ERROR;
2934 }
2935
2936 if (jtag_interface_init(cmd_ctx) != ERROR_OK)
2937 return ERROR_JTAG_INIT_FAILED;
2938
2939 jtag_add_reset(trst, srst);
2940 jtag_execute_queue();
2941
2942 return ERROR_OK;
2943 }
2944
2945 static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2946 {
2947 if (argc < 1)
2948 {
2949 return ERROR_COMMAND_SYNTAX_ERROR;
2950 }
2951
2952 jtag_add_runtest(strtol(args[0], NULL, 0), TAP_INVALID);
2953 jtag_execute_queue();
2954
2955 return ERROR_OK;
2956
2957 }
2958
2959 /*
2960 * For "irscan" or "drscan" commands, the "end" (really, "next") state
2961 * should be stable ... and *NOT* a shift state, otherwise free-running
2962 * jtag clocks could change the values latched by the update state.
2963 */
2964 static bool scan_is_safe(tap_state_t state)
2965 {
2966 switch (state)
2967 {
2968 case TAP_RESET:
2969 case TAP_IDLE:
2970 case TAP_DRPAUSE:
2971 case TAP_IRPAUSE:
2972 return true;
2973 default:
2974 return false;
2975 }
2976 }
2977
2978
2979 static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
2980 {
2981 int i;
2982 scan_field_t *fields;
2983 jtag_tap_t *tap;
2984 tap_state_t endstate;
2985
2986 if ((argc < 2) || (argc % 2))
2987 {
2988 return ERROR_COMMAND_SYNTAX_ERROR;
2989 }
2990
2991 /* optional "-endstate" "statename" at the end of the arguments,
2992 * so that e.g. IRPAUSE can let us load the data register before
2993 * entering RUN/IDLE to execute the instruction we load here.
2994 */
2995 endstate = TAP_IDLE;
2996
2997 if( argc >= 4 ){
2998 /* have at least one pair of numbers. */
2999 /* is last pair the magic text? */
3000 if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){
3001 const char *cpA;
3002 const char *cpS;
3003 cpA = args[ argc-1 ];
3004 for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){
3005 cpS = tap_state_name( endstate );
3006 if( 0 == strcmp( cpA, cpS ) ){
3007 break;
3008 }
3009 }
3010 if( endstate >= TAP_NUM_STATES ){
3011 return ERROR_COMMAND_SYNTAX_ERROR;
3012 } else {
3013 if (!scan_is_safe(endstate))
3014 LOG_WARNING("irscan with unsafe "
3015 "endstate \"%s\"", cpA);
3016 /* found - remove the last 2 args */
3017 argc -= 2;
3018 }
3019 }
3020 }
3021
3022 int num_fields = argc / 2;
3023
3024 fields = malloc(sizeof(scan_field_t) * num_fields);
3025
3026 for (i = 0; i < num_fields; i++)
3027 {
3028 tap = jtag_TapByString( args[i*2] );
3029 if (tap==NULL)
3030 {
3031 command_print( cmd_ctx, "Tap: %s unknown", args[i*2] );
3032 return ERROR_FAIL;
3033 }
3034 int field_size = tap->ir_length;
3035 fields[i].tap = tap;
3036 fields[i].num_bits = field_size;
3037 fields[i].out_value = malloc(CEIL(field_size, 8));
3038 buf_set_u32(fields[i].out_value, 0, field_size, strtoul(args[i*2+1], NULL, 0));
3039 fields[i].in_value = NULL;
3040 }
3041
3042 /* did we have an endstate? */
3043 jtag_add_ir_scan(num_fields, fields, endstate);
3044
3045 int retval=jtag_execute_queue();
3046
3047 for (i = 0; i < num_fields; i++)
3048 free(fields[i].out_value);
3049
3050 free (fields);
3051
3052 return retval;
3053 }
3054
3055 static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3056 {
3057 int retval;
3058 scan_field_t *fields;
3059 int num_fields;
3060 int field_count = 0;
3061 int i, e;
3062 jtag_tap_t *tap;
3063 tap_state_t endstate;
3064
3065 /* args[1] = device
3066 * args[2] = num_bits
3067 * args[3] = hex string
3068 * ... repeat num bits and hex string ...
3069 *
3070 * .. optionally:
3071 * args[N-2] = "-endstate"
3072 * args[N-1] = statename
3073 */
3074 if ((argc < 4) || ((argc % 2)!=0))
3075 {
3076 Jim_WrongNumArgs(interp, 1, args, "wrong arguments");
3077 return JIM_ERR;
3078 }
3079
3080 endstate = TAP_IDLE;
3081
3082 /* validate arguments as numbers */
3083 e = JIM_OK;
3084 for (i = 2; i < argc; i+=2)
3085 {
3086 long bits;
3087 const char *cp;
3088
3089 e = Jim_GetLong(interp, args[i], &bits);
3090 /* If valid - try next arg */
3091 if( e == JIM_OK ){
3092 continue;
3093 }
3094
3095 /* Not valid.. are we at the end? */
3096 if ( ((i+2) != argc) ){
3097 /* nope, then error */
3098 return e;
3099 }
3100
3101 /* it could be: "-endstate FOO"
3102 * e.g. DRPAUSE so we can issue more instructions
3103 * before entering RUN/IDLE and executing them.
3104 */
3105
3106 /* get arg as a string. */
3107 cp = Jim_GetString( args[i], NULL );
3108 /* is it the magic? */
3109 if( 0 == strcmp( "-endstate", cp ) ){
3110 /* is the statename valid? */
3111 cp = Jim_GetString( args[i+1], NULL );
3112
3113 /* see if it is a valid state name */
3114 endstate = tap_state_by_name(cp);
3115 if( endstate < 0 ){
3116 /* update the error message */
3117 Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp );
3118 } else {
3119 if (!scan_is_safe(endstate))
3120 LOG_WARNING("drscan with unsafe "
3121 "endstate \"%s\"", cp);
3122
3123 /* valid - so clear the error */
3124 e = JIM_OK;
3125 /* and remove the last 2 args */
3126 argc -= 2;
3127 }
3128 }
3129
3130 /* Still an error? */
3131 if( e != JIM_OK ){
3132 return e; /* too bad */
3133 }
3134 } /* validate args */
3135
3136 tap = jtag_TapByJimObj( interp, args[1] );
3137 if( tap == NULL ){
3138 return JIM_ERR;
3139 }
3140
3141 num_fields=(argc-2)/2;
3142 fields = malloc(sizeof(scan_field_t) * num_fields);
3143 for (i = 2; i < argc; i+=2)
3144 {
3145 long bits;
3146 int len;
3147 const char *str;
3148
3149 Jim_GetLong(interp, args[i], &bits);
3150 str = Jim_GetString(args[i+1], &len);
3151
3152 fields[field_count].tap = tap;
3153 fields[field_count].num_bits = bits;
3154 fields[field_count].out_value = malloc(CEIL(bits, 8));
3155 str_to_buf(str, len, fields[field_count].out_value, bits, 0);
3156 fields[field_count].in_value = fields[field_count].out_value;
3157 field_count++;
3158 }
3159
3160 jtag_add_dr_scan(num_fields, fields, endstate);
3161
3162 retval = jtag_execute_queue();
3163 if (retval != ERROR_OK)
3164 {
3165 Jim_SetResultString(interp, "drscan: jtag execute failed",-1);
3166 return JIM_ERR;
3167 }
3168
3169 field_count=0;
3170 Jim_Obj *list = Jim_NewListObj(interp, NULL, 0);
3171 for (i = 2; i < argc; i+=2)
3172 {
3173 long bits;
3174 char *str;
3175
3176 Jim_GetLong(interp, args[i], &bits);
3177 str = buf_to_str(fields[field_count].in_value, bits, 16);
3178 free(fields[field_count].out_value);
3179
3180 Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
3181 free(str);
3182 field_count++;
3183 }
3184
3185 Jim_SetResult(interp, list);
3186
3187 free(fields);
3188
3189 return JIM_OK;
3190 }
3191
3192
3193 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
3194 {
3195 Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_flush_queue_count));
3196
3197 return JIM_OK;
3198 }
3199
3200
3201 static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3202 {
3203 if (argc == 1)
3204 {
3205 if (strcmp(args[0], "enable") == 0)
3206 {
3207 jtag_verify_capture_ir = 1;
3208 }
3209 else if (strcmp(args[0], "disable") == 0)
3210 {
3211 jtag_verify_capture_ir = 0;
3212 } else
3213 {
3214 return ERROR_COMMAND_SYNTAX_ERROR;
3215 }
3216 } else if (argc != 0)
3217 {
3218 return ERROR_COMMAND_SYNTAX_ERROR;
3219 }
3220
3221 command_print(cmd_ctx, "verify Capture-IR is %s", (jtag_verify_capture_ir) ? "enabled": "disabled");
3222
3223 return ERROR_OK;
3224 }
3225
3226 static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3227 {
3228 if (argc == 1)
3229 {
3230 if (strcmp(args[0], "enable") == 0)
3231 {
3232 jtag_verify = 1;
3233 }
3234 else if (strcmp(args[0], "disable") == 0)
3235 {
3236 jtag_verify = 0;
3237 } else
3238 {
3239 return ERROR_COMMAND_SYNTAX_ERROR;
3240 }
3241 } else if (argc != 0)
3242 {
3243 return ERROR_COMMAND_SYNTAX_ERROR;
3244 }
3245
3246 command_print(cmd_ctx, "verify jtag capture is %s", (jtag_verify) ? "enabled": "disabled");
3247
3248 return ERROR_OK;
3249 }
3250
3251
3252 int jtag_power_dropout(int *dropout)
3253 {
3254 return jtag->power_dropout(dropout);
3255 }
3256
3257 int jtag_srst_asserted(int *srst_asserted)
3258 {
3259 return jtag->srst_asserted(srst_asserted);
3260 }
3261
3262 void jtag_tap_handle_event( jtag_tap_t * tap, enum jtag_tap_event e)
3263 {
3264 jtag_tap_event_action_t * jteap;
3265 int done;
3266
3267 jteap = tap->event_action;
3268
3269 done = 0;
3270 while (jteap) {
3271 if (jteap->event == e) {
3272 done = 1;
3273 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
3274 tap->dotted_name,
3275 e,
3276 Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name,
3277 Jim_GetString(jteap->body, NULL) );
3278 if (Jim_EvalObj(interp, jteap->body) != JIM_OK) {
3279 Jim_PrintErrorMessage(interp);
3280 }
3281 }
3282
3283 jteap = jteap->next;
3284 }
3285
3286 if (!done) {
3287 LOG_DEBUG( "event %d %s - no action",
3288 e,
3289 Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name);
3290 }
3291 }
3292
3293 /*-----<Cable Helper API>---------------------------------------*/
3294
3295 /* these Cable Helper API functions are all documented in the jtag.h header file,
3296 using a Doxygen format. And since Doxygen's configuration file "Doxyfile",
3297 is setup to prefer its docs in the header file, no documentation is here, for
3298 if it were, it would have to be doubly maintained.
3299 */
3300
3301 /**
3302 * @see tap_set_state() and tap_get_state() accessors.
3303 * Actual name is not important since accessors hide it.
3304 */
3305 static tap_state_t state_follower = TAP_RESET;
3306
3307 void tap_set_state_impl( tap_state_t new_state )
3308 {
3309 /* this is the state we think the TAPs are in now, was cur_state */
3310 state_follower = new_state;
3311 }
3312
3313 tap_state_t tap_get_state()
3314 {
3315 return state_follower;
3316 }
3317
3318 /**
3319 * @see tap_set_end_state() and tap_get_end_state() accessors.
3320 * Actual name is not important because accessors hide it.
3321 */
3322 static tap_state_t end_state_follower = TAP_RESET;
3323
3324 void tap_set_end_state( tap_state_t new_end_state )
3325 {
3326 /* this is the state we think the TAPs will be in at completion of the
3327 current TAP operation, was end_state
3328 */
3329 end_state_follower = new_end_state;
3330 }
3331
3332 tap_state_t tap_get_end_state()
3333 {
3334 return end_state_follower;
3335 }
3336
3337
3338 int tap_move_ndx( tap_state_t astate )
3339 {
3340 /* given a stable state, return the index into the tms_seqs[] array within tap_get_tms_path() */
3341
3342 int ndx;
3343
3344 switch( astate )
3345 {
3346 case TAP_RESET: ndx = 0; break;
3347 case TAP_DRSHIFT: ndx = 2; break;
3348 case TAP_DRPAUSE: ndx = 3; break;
3349 case TAP_IDLE: ndx = 1; break;
3350 case TAP_IRSHIFT: ndx = 4; break;
3351 case TAP_IRPAUSE: ndx = 5; break;
3352 default:
3353 LOG_ERROR( "fatal: unstable state \"%s\" used in tap_move_ndx()", tap_state_name(astate) );
3354 exit(1);
3355 }
3356
3357 return ndx;
3358 }
3359
3360
3361 /* tap_move[i][j]: tap movement command to go from state i to state j
3362 * 0: Test-Logic-Reset
3363 * 1: Run-Test/Idle
3364 * 2: Shift-DR
3365 * 3: Pause-DR
3366 * 4: Shift-IR
3367 * 5: Pause-IR
3368 *
3369 * DRSHIFT->DRSHIFT and IRSHIFT->IRSHIFT have to be caught in interface specific code
3370 */
3371 struct tms_sequences
3372 {
3373 u8 bits;
3374 u8 bit_count;
3375
3376 };
3377
3378 /*
3379 * These macros allow us to specify TMS state transitions by bits rather than hex bytes.
3380 * Read the bits from LSBit first to MSBit last (right-to-left).
3381 */
3382 #define HEX__(n) 0x##n##LU
3383
3384 #define B8__(x) \
3385 (((x) & 0x0000000FLU)?(1<<0):0) \
3386 +(((x) & 0x000000F0LU)?(1<<1):0) \
3387 +(((x) & 0x00000F00LU)?(1<<2):0) \
3388 +(((x) & 0x0000F000LU)?(1<<3):0) \
3389 +(((x) & 0x000F0000LU)?(1<<4):0) \
3390 +(((x) & 0x00F00000LU)?(1<<5):0) \
3391 +(((x) & 0x0F000000LU)?(1<<6):0) \
3392 +(((x) & 0xF0000000LU)?(1<<7):0)
3393
3394 #define B8(bits,count) { ((u8)B8__(HEX__(bits))), (count) }
3395
3396 static const struct tms_sequences old_tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3397 {
3398 /* value clocked to TMS to move from one of six stable states to another.
3399 * N.B. OOCD clocks TMS from LSB first, so read these right-to-left.
3400 * N.B. These values are tightly bound to the table in tap_get_tms_path_len().
3401 * N.B. Reset only needs to be 0b11111, but in JLink an even byte of 1's is more stable.
3402 * These extra ones cause no TAP state problem, because we go into reset and stay in reset.
3403 */
3404
3405
3406
3407 /* to state: */
3408 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3409 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3410 { B8(1111111,7), B8(0000000,7), B8(0100101,7), B8(0000101,7), B8(0101011,7), B8(0001011,7) }, /* IDLE */
3411 { B8(1111111,7), B8(0110001,7), B8(0000000,7), B8(0000001,7), B8(0001111,7), B8(0101111,7) }, /* DRSHIFT */
3412 { B8(1111111,7), B8(0110000,7), B8(0100000,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* DRPAUSE */
3413 { B8(1111111,7), B8(0110001,7), B8(0000111,7), B8(0010111,7), B8(0000000,7), B8(0000001,7) }, /* IRSHIFT */
3414 { B8(1111111,7), B8(0110000,7), B8(0011100,7), B8(0010111,7), B8(0011110,7), B8(0101111,7) }, /* IRPAUSE */
3415 };
3416
3417
3418
3419 static const struct tms_sequences short_tms_seqs[6][6] = /* [from_state_ndx][to_state_ndx] */
3420 {
3421 /* this is the table submitted by Jeff Williams on 3/30/2009 with this comment:
3422
3423 OK, I added Peter's version of the state table, and it works OK for
3424 me on MC1322x. I've recreated the jlink portion of patch with this
3425 new state table. His changes to my state table are pretty minor in
3426 terms of total transitions, but Peter feels that his version fixes
3427 some long-standing problems.
3428 Jeff
3429
3430 I added the bit count into the table, reduced RESET column to 7 bits from 8.
3431 Dick
3432
3433 state specific comments:
3434 ------------------------
3435 *->RESET tried the 5 bit reset and it gave me problems, 7 bits seems to
3436 work better on ARM9 with ft2232 driver. (Dick)
3437
3438 RESET->DRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3439 needed on ARM9 with ft2232 driver. (Dick)
3440
3441 RESET->IRSHIFT add 1 extra clock cycles in the RESET state before advancing.
3442 needed on ARM9 with ft2232 driver. (Dick)
3443 */
3444
3445 /* to state: */
3446 /* RESET IDLE DRSHIFT DRPAUSE IRSHIFT IRPAUSE */ /* from state: */
3447 { B8(1111111,7), B8(0000000,7), B8(0010111,7), B8(0001010,7), B8(0011011,7), B8(0010110,7) }, /* RESET */
3448 { B8(1111111,7), B8(0000000,7), B8(001,3), B8(0101,4), B8(0011,4), B8(01011,5) }, /* IDLE */
3449 { B8(1111111,7), B8(011,3), B8(00111,5), B8(01,2), B8(001111,6), B8(0101111,7) }, /* DRSHIFT */
3450 { B8(1111111,7), B8(011,3), B8(01,2), B8(0,1), B8(001111,6), B8(0101111,7) }, /* DRPAUSE */
3451 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(001111,6), B8(01,2) }, /* IRSHIFT */
3452 { B8(1111111,7), B8(011,3), B8(00111,5), B8(010111,6), B8(01,2), B8(0,1) } /* IRPAUSE */
3453
3454 };
3455
3456 typedef const struct tms_sequences tms_table[6][6];
3457
3458 static tms_table *tms_seqs=&short_tms_seqs;
3459
3460 int tap_get_tms_path( tap_state_t from, tap_state_t to )
3461 {
3462 return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bits;
3463 }
3464
3465
3466 int tap_get_tms_path_len( tap_state_t from, tap_state_t to )
3467 {
3468 return (*tms_seqs)[tap_move_ndx(from)][tap_move_ndx(to)].bit_count;
3469 }
3470
3471
3472 bool tap_is_state_stable(tap_state_t astate)
3473 {
3474 bool is_stable;
3475
3476 /* A switch() is used because it is symbol dependent
3477 (not value dependent like an array), and can also check bounds.
3478 */
3479 switch( astate )
3480 {
3481 case TAP_RESET:
3482 case TAP_IDLE:
3483 case TAP_DRSHIFT:
3484 case TAP_DRPAUSE:
3485 case TAP_IRSHIFT:
3486 case TAP_IRPAUSE:
3487 is_stable = true;
3488 break;
3489 default:
3490 is_stable = false;
3491 }
3492
3493 return is_stable;
3494 }
3495
3496 tap_state_t tap_state_transition(tap_state_t cur_state, bool tms)
3497 {
3498 tap_state_t new_state;
3499
3500 /* A switch is used because it is symbol dependent and not value dependent
3501 like an array. Also it can check for out of range conditions.
3502 */
3503
3504 if (tms)
3505 {
3506 switch (cur_state)
3507 {
3508 case TAP_RESET:
3509 new_state = cur_state;
3510 break;
3511 case TAP_IDLE:
3512 case TAP_DRUPDATE:
3513 case TAP_IRUPDATE:
3514 new_state = TAP_DRSELECT;
3515 break;
3516 case TAP_DRSELECT:
3517 new_state = TAP_IRSELECT;
3518 break;
3519 case TAP_DRCAPTURE:
3520 case TAP_DRSHIFT:
3521 new_state = TAP_DREXIT1;
3522 break;
3523 case TAP_DREXIT1:
3524 case TAP_DREXIT2:
3525 new_state = TAP_DRUPDATE;
3526 break;
3527 case TAP_DRPAUSE:
3528 new_state = TAP_DREXIT2;
3529 break;
3530 case TAP_IRSELECT:
3531 new_state = TAP_RESET;
3532 break;
3533 case TAP_IRCAPTURE:
3534 case TAP_IRSHIFT:
3535 new_state = TAP_IREXIT1;
3536 break;
3537 case TAP_IREXIT1:
3538 case TAP_IREXIT2:
3539 new_state = TAP_IRUPDATE;
3540 break;
3541 case TAP_IRPAUSE:
3542 new_state = TAP_IREXIT2;
3543 break;
3544 default:
3545 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3546 exit(1);
3547 break;
3548 }
3549 }
3550 else
3551 {
3552 switch (cur_state)
3553 {
3554 case TAP_RESET:
3555 case TAP_IDLE:
3556 case TAP_DRUPDATE:
3557 case TAP_IRUPDATE:
3558 new_state = TAP_IDLE;
3559 break;
3560 case TAP_DRSELECT:
3561 new_state = TAP_DRCAPTURE;
3562 break;
3563 case TAP_DRCAPTURE:
3564 case TAP_DRSHIFT:
3565 case TAP_DREXIT2:
3566 new_state = TAP_DRSHIFT;
3567 break;
3568 case TAP_DREXIT1:
3569 case TAP_DRPAUSE:
3570 new_state = TAP_DRPAUSE;
3571 break;
3572 case TAP_IRSELECT:
3573 new_state = TAP_IRCAPTURE;
3574 break;
3575 case TAP_IRCAPTURE:
3576 case TAP_IRSHIFT:
3577 case TAP_IREXIT2:
3578 new_state = TAP_IRSHIFT;
3579 break;
3580 case TAP_IREXIT1:
3581 case TAP_IRPAUSE:
3582 new_state = TAP_IRPAUSE;
3583 break;
3584 default:
3585 LOG_ERROR( "fatal: invalid argument cur_state=%d", cur_state );
3586 exit(1);
3587 break;
3588 }
3589 }
3590
3591 return new_state;
3592 }
3593
3594 const char* tap_state_name(tap_state_t state)
3595 {
3596 const char* ret;
3597
3598 switch( state )
3599 {
3600 case TAP_RESET: ret = "RESET"; break;
3601 case TAP_IDLE: ret = "RUN/IDLE"; break;
3602 case TAP_DRSELECT: ret = "DRSELECT"; break;
3603 case TAP_DRCAPTURE: ret = "DRCAPTURE"; break;
3604 case TAP_DRSHIFT: ret = "DRSHIFT"; break;
3605 case TAP_DREXIT1: ret = "DREXIT1"; break;
3606 case TAP_DRPAUSE: ret = "DRPAUSE"; break;
3607 case TAP_DREXIT2: ret = "DREXIT2"; break;
3608 case TAP_DRUPDATE: ret = "DRUPDATE"; break;
3609 case TAP_IRSELECT: ret = "IRSELECT"; break;
3610 case TAP_IRCAPTURE: ret = "IRCAPTURE"; break;
3611 case TAP_IRSHIFT: ret = "IRSHIFT"; break;
3612 case TAP_IREXIT1: ret = "IREXIT1"; break;
3613 case TAP_IRPAUSE: ret = "IRPAUSE"; break;
3614 case TAP_IREXIT2: ret = "IREXIT2"; break;
3615 case TAP_IRUPDATE: ret = "IRUPDATE"; break;
3616 default: ret = "???";
3617 }
3618
3619 return ret;
3620 }
3621
3622 static tap_state_t tap_state_by_name( const char *name )
3623 {
3624 tap_state_t x;
3625
3626 for( x = 0 ; x < TAP_NUM_STATES ; x++ ){
3627 /* be nice to the human */
3628 if( 0 == strcasecmp( name, tap_state_name(x) ) ){
3629 return x;
3630 }
3631 }
3632 /* not found */
3633 return TAP_INVALID;
3634 }
3635
3636 #ifdef _DEBUG_JTAG_IO_
3637
3638 #define JTAG_DEBUG_STATE_APPEND(buf, len, bit) \
3639 do { buf[len] = bit ? '1' : '0'; } while(0)
3640 #define JTAG_DEBUG_STATE_PRINT(a, b, astr, bstr) \
3641 DEBUG_JTAG_IO("TAP/SM: %9s -> %5s\tTMS: %s\tTDI: %s", \
3642 tap_state_name(a), tap_state_name(b), astr, bstr)
3643
3644 tap_state_t jtag_debug_state_machine(const void *tms_buf, const void *tdi_buf,
3645 unsigned tap_bits, tap_state_t next_state)
3646 {
3647 const u8 *tms_buffer;
3648 const u8 *tdi_buffer;
3649 unsigned tap_bytes;
3650 unsigned cur_byte;
3651 unsigned cur_bit;
3652
3653 unsigned tap_out_bits;
3654 char tms_str[33];
3655 char tdi_str[33];
3656
3657 tap_state_t last_state;
3658
3659 // set startstate (and possibly last, if tap_bits == 0)
3660 last_state = next_state;
3661 DEBUG_JTAG_IO("TAP/SM: START state: %s", tap_state_name(next_state));
3662
3663 tms_buffer = (const u8 *)tms_buf;
3664 tdi_buffer = (const u8 *)tdi_buf;
3665
3666 tap_bytes = TAP_SCAN_BYTES(tap_bits);
3667 DEBUG_JTAG_IO("TAP/SM: TMS bits: %u (bytes: %u)", tap_bits, tap_bytes);
3668
3669 tap_out_bits = 0;
3670 for(cur_byte = 0; cur_byte < tap_bytes; cur_byte++)
3671 {
3672 for(cur_bit = 0; cur_bit < 8; cur_bit++)
3673 {
3674 // make sure we do not run off the end of the buffers
3675 unsigned tap_bit = cur_byte * 8 + cur_bit;
3676 if (tap_bit == tap_bits)
3677 break;
3678
3679 // check and save TMS bit
3680 tap_bit = !!(tms_buffer[cur_byte] & (1 << cur_bit));
3681 JTAG_DEBUG_STATE_APPEND(tms_str, tap_out_bits, tap_bit);
3682
3683 // use TMS bit to find the next TAP state
3684 next_state = tap_state_transition(last_state, tap_bit);
3685
3686 // check and store TDI bit
3687 tap_bit = !!(tdi_buffer[cur_byte] & (1 << cur_bit));
3688 JTAG_DEBUG_STATE_APPEND(tdi_str, tap_out_bits, tap_bit);
3689
3690 // increment TAP bits
3691 tap_out_bits++;
3692
3693 // Only show TDO bits on state transitions, or
3694 // after some number of bits in the same state.
3695 if ((next_state == last_state) && (tap_out_bits < 32))
3696 continue;
3697
3698 // terminate strings and display state transition
3699 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3700 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3701
3702 // reset state
3703 last_state = next_state;
3704 tap_out_bits = 0;
3705 }
3706 }
3707
3708 if (tap_out_bits)
3709 {
3710 // terminate strings and display state transition
3711 tms_str[tap_out_bits] = tdi_str[tap_out_bits] = 0;
3712 JTAG_DEBUG_STATE_PRINT(last_state, next_state, tms_str, tdi_str);
3713 }
3714
3715 DEBUG_JTAG_IO("TAP/SM: FINAL state: %s", tap_state_name(next_state));
3716
3717 return next_state;
3718 }
3719 #endif // _DEBUG_JTAG_IO_
3720
3721 #ifndef HAVE_JTAG_MINIDRIVER_H
3722 void jtag_alloc_in_value32(scan_field_t *field)
3723 {
3724 field->in_value=(u8 *)cmd_queue_alloc(4);
3725 }
3726 #endif
3727
3728 static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
3729 {
3730 if (argc == 1)
3731 {
3732 if (strcmp(args[0], "short") == 0)
3733 {
3734 tms_seqs=&short_tms_seqs;
3735 }
3736 else if (strcmp(args[0], "long") == 0)
3737 {
3738 tms_seqs=&old_tms_seqs;
3739 } else
3740 {
3741 return ERROR_COMMAND_SYNTAX_ERROR;
3742 }
3743 } else if (argc != 0)
3744 {
3745 return ERROR_COMMAND_SYNTAX_ERROR;
3746 }
3747
3748 command_print(cmd_ctx, "tms sequence is %s", (tms_seqs==&short_tms_seqs) ? "short": "long");
3749
3750 return ERROR_OK;
3751 }
3752
3753 /*-----</Cable Helper API>--------------------------------------*/
3754
3755
3756 /**
3757 * Function jtag_add_statemove
3758 * moves from the current state to the goal \a state. This needs
3759 * to be handled according to the xsvf spec, see the XSTATE command
3760 * description.
3761 */
3762 int jtag_add_statemove(tap_state_t goal_state)
3763 {
3764 int retval = ERROR_OK;
3765
3766 tap_state_t moves[8];
3767 tap_state_t cur_state = cmd_queue_cur_state;
3768 int i;
3769 int tms_bits;
3770 int tms_count;
3771
3772 LOG_DEBUG( "cur_state=%s goal_state=%s",
3773 tap_state_name(cur_state),
3774 tap_state_name(goal_state) );
3775
3776
3777 /* From the XSVF spec, pertaining to XSTATE:
3778
3779 For special states known as stable states (Test-Logic-Reset,
3780 Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
3781 predefined TAP state paths when the starting state is a stable state and
3782 when the XSTATE specifies a new stable state (see the STATE command in
3783 the [Ref 5] for the TAP state paths between stable states). For
3784 non-stable states, XSTATE should specify a state that is only one TAP
3785 state transition distance from the current TAP state to avoid undefined
3786 TAP state paths. A sequence of multiple XSTATE commands can be issued to
3787 transition the TAP through a specific state path.
3788 */
3789
3790 if (goal_state==cur_state )
3791 ; /* nothing to do */
3792
3793 else if( goal_state==TAP_RESET )
3794 {
3795 jtag_add_tlr();
3796 }
3797
3798 else if( tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state) )
3799 {
3800 /* note: unless tms_bits holds a path that agrees with [Ref 5] in above
3801 spec, then this code is not fully conformant to the xsvf spec. This
3802 puts a burden on tap_get_tms_path() function from the xsvf spec.
3803 If in doubt, you should confirm that that burden is being met.
3804 */
3805
3806 tms_bits = tap_get_tms_path(cur_state, goal_state);
3807 tms_count = tap_get_tms_path_len(cur_state, goal_state);
3808
3809 assert( (unsigned) tms_count < DIM(moves) );
3810
3811 for (i=0; i<tms_count; i++, tms_bits>>=1)
3812 {
3813 bool bit = tms_bits & 1;
3814
3815 cur_state = tap_state_transition(cur_state, bit);
3816 moves[i] = cur_state;
3817 }
3818
3819 jtag_add_pathmove(tms_count, moves);
3820 }
3821
3822 /* else state must be immediately reachable in one clock cycle, and does not
3823 need to be a stable state.
3824 */
3825 else if( tap_state_transition(cur_state, true) == goal_state
3826 || tap_state_transition(cur_state, false) == goal_state )
3827 {
3828 /* move a single state */
3829 moves[0] = goal_state;
3830 jtag_add_pathmove( 1, moves );
3831 }
3832
3833 else
3834 {
3835 retval = ERROR_FAIL;
3836 }
3837
3838 return retval;
3839 }
3840
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)