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