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