Code Review / openocd.git / blob
? search:


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