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