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