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