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