]> git.sur5r.net Git - openocd/blob - src/jtag/core.c
error handling: the error number is not part of the user interface
[openocd] / src / jtag / core.c
1 /***************************************************************************
2  *   Copyright (C) 2009 Zachary T Welch                                    *
3  *   zw@superlucidity.net                                                  *
4  *                                                                         *
5  *   Copyright (C) 2007,2008,2009 Ã˜yvind Harboe                            *
6  *   oyvind.harboe@zylin.com                                               *
7  *                                                                         *
8  *   Copyright (C) 2009 SoftPLC Corporation                                *
9  *       http://softplc.com                                                *
10  *   dick@softplc.com                                                      *
11  *                                                                         *
12  *   Copyright (C) 2005 by Dominic Rath                                    *
13  *   Dominic.Rath@gmx.de                                                   *
14  *                                                                         *
15  *   This program is free software; you can redistribute it and/or modify  *
16  *   it under the terms of the GNU General Public License as published by  *
17  *   the Free Software Foundation; either version 2 of the License, or     *
18  *   (at your option) any later version.                                   *
19  *                                                                         *
20  *   This program is distributed in the hope that it will be useful,       *
21  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
22  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
23  *   GNU General Public License for more details.                          *
24  *                                                                         *
25  *   You should have received a copy of the GNU General Public License     *
26  *   along with this program; if not, write to the                         *
27  *   Free Software Foundation, Inc.,                                       *
28  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
29  ***************************************************************************/
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33
34 #include "jtag.h"
35 #include "interface.h"
36 #include "transport.h"
37
38 #ifdef HAVE_STRINGS_H
39 #include <strings.h>
40 #endif
41
42 /* SVF and XSVF are higher level JTAG command sets (for boundary scan) */
43 #include "svf/svf.h"
44 #include "xsvf/xsvf.h"
45
46 /// The number of JTAG queue flushes (for profiling and debugging purposes).
47 static int jtag_flush_queue_count;
48
49 // Sleep this # of ms after flushing the queue
50 static int jtag_flush_queue_sleep = 0;
51
52 static void jtag_add_scan_check(struct jtag_tap *active,
53                 void (*jtag_add_scan)(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields, tap_state_t state),
54                 int in_num_fields, struct scan_field *in_fields, tap_state_t state);
55
56 /**
57  * The jtag_error variable is set when an error occurs while executing
58  * the queue.  Application code may set this using jtag_set_error(),
59  * when an error occurs during processing that should be reported during
60  * jtag_execute_queue().
61  *
62  * The value is set and cleared, but never read by normal application code.
63  *
64  * This value is returned (and cleared) by jtag_execute_queue().
65  */
66 static int jtag_error = ERROR_OK;
67
68 static const char *jtag_event_strings[] =
69 {
70         [JTAG_TRST_ASSERTED] = "TAP reset",
71         [JTAG_TAP_EVENT_SETUP] = "TAP setup",
72         [JTAG_TAP_EVENT_ENABLE] = "TAP enabled",
73         [JTAG_TAP_EVENT_DISABLE] = "TAP disabled",
74 };
75
76 /*
77  * JTAG adapters must initialize with TRST and SRST de-asserted
78  * (they're negative logic, so that means *high*).  But some
79  * hardware doesn't necessarily work that way ... so set things
80  * up so that jtag_init() always forces that state.
81  */
82 static int jtag_trst = -1;
83 static int jtag_srst = -1;
84
85 /**
86  * List all TAPs that have been created.
87  */
88 static struct jtag_tap *__jtag_all_taps = NULL;
89 /**
90  * The number of TAPs in the __jtag_all_taps list, used to track the
91  * assigned chain position to new TAPs
92  */
93 static unsigned jtag_num_taps = 0;
94
95 static enum reset_types jtag_reset_config = RESET_NONE;
96 tap_state_t cmd_queue_cur_state = TAP_RESET;
97
98 static bool jtag_verify_capture_ir = true;
99 static int jtag_verify = 1;
100
101 /* how long the OpenOCD should wait before attempting JTAG communication after reset lines deasserted (in ms) */
102 static int adapter_nsrst_delay = 0; /* default to no nSRST delay */
103 static int jtag_ntrst_delay = 0; /* default to no nTRST delay */
104 static int adapter_nsrst_assert_width = 0; /* width of assertion */
105 static int jtag_ntrst_assert_width = 0; /* width of assertion */
106
107 /**
108  * Contains a single callback along with a pointer that will be passed
109  * when an event occurs.
110  */
111 struct jtag_event_callback {
112         /// a event callback
113         jtag_event_handler_t callback;
114         /// the private data to pass to the callback
115         void* priv;
116         /// the next callback
117         struct jtag_event_callback* next;
118 };
119
120 /* callbacks to inform high-level handlers about JTAG state changes */
121 static struct jtag_event_callback *jtag_event_callbacks;
122
123 /* speed in kHz*/
124 static int speed_khz = 0;
125 /* speed to fallback to when RCLK is requested but not supported */
126 static int rclk_fallback_speed_khz = 0;
127 static enum {CLOCK_MODE_SPEED, CLOCK_MODE_KHZ, CLOCK_MODE_RCLK} clock_mode;
128 static int jtag_speed = 0;
129
130 static struct jtag_interface *jtag = NULL;
131
132
133 const struct swd_driver *swd = NULL;
134
135 /* configuration */
136 struct jtag_interface *jtag_interface = NULL;
137
138 void jtag_set_flush_queue_sleep(int ms)
139 {
140         jtag_flush_queue_sleep = ms;
141 }
142
143 void jtag_set_error(int error)
144 {
145         if ((error == ERROR_OK) || (jtag_error != ERROR_OK))
146                 return;
147         jtag_error = error;
148 }
149
150 int jtag_error_clear(void)
151 {
152         int temp = jtag_error;
153         jtag_error = ERROR_OK;
154         return temp;
155 }
156
157 /************/
158
159 static bool jtag_poll = 1;
160
161 bool is_jtag_poll_safe(void)
162 {
163         /* Polling can be disabled explicitly with set_enabled(false).
164          * It is also implicitly disabled while TRST is active and
165          * while SRST is gating the JTAG clock.
166          */
167         if (!jtag_poll || jtag_trst != 0)
168                 return false;
169         return jtag_srst == 0 || (jtag_reset_config & RESET_SRST_NO_GATING);
170 }
171
172 bool jtag_poll_get_enabled(void)
173 {
174         return jtag_poll;
175 }
176
177 void jtag_poll_set_enabled(bool value)
178 {
179         jtag_poll = value;
180 }
181
182 /************/
183
184 struct jtag_tap *jtag_all_taps(void)
185 {
186         return __jtag_all_taps;
187 };
188
189 unsigned jtag_tap_count(void)
190 {
191         return jtag_num_taps;
192 }
193
194 unsigned jtag_tap_count_enabled(void)
195 {
196         struct jtag_tap *t = jtag_all_taps();
197         unsigned n = 0;
198         while (t)
199         {
200                 if (t->enabled)
201                         n++;
202                 t = t->next_tap;
203         }
204         return n;
205 }
206
207 /// Append a new TAP to the chain of all taps.
208 void jtag_tap_add(struct jtag_tap *t)
209 {
210         t->abs_chain_position = jtag_num_taps++;
211
212         struct jtag_tap **tap = &__jtag_all_taps;
213         while (*tap != NULL)
214                 tap = &(*tap)->next_tap;
215         *tap = t;
216 }
217
218 /* returns a pointer to the n-th device in the scan chain */
219 static inline struct jtag_tap *jtag_tap_by_position(unsigned n)
220 {
221         struct jtag_tap *t = jtag_all_taps();
222
223         while (t && n-- > 0)
224                 t = t->next_tap;
225
226         return t;
227 }
228
229 struct jtag_tap *jtag_tap_by_string(const char *s)
230 {
231         /* try by name first */
232         struct jtag_tap *t = jtag_all_taps();
233
234         while (t)
235         {
236                 if (0 == strcmp(t->dotted_name, s))
237                         return t;
238                 t = t->next_tap;
239         }
240
241         /* no tap found by name, so try to parse the name as a number */
242         unsigned n;
243         if (parse_uint(s, &n) != ERROR_OK)
244                 return NULL;
245
246         /* FIXME remove this numeric fallback code late June 2010, along
247          * with all info in the User's Guide that TAPs have numeric IDs.
248          * Also update "scan_chain" output to not display the numbers.
249          */
250         t = jtag_tap_by_position(n);
251         if (t)
252                 LOG_WARNING("Specify TAP '%s' by name, not number %u",
253                         t->dotted_name, n);
254
255         return t;
256 }
257
258 struct jtag_tap* jtag_tap_next_enabled(struct jtag_tap* p)
259 {
260         p = p ? p->next_tap : jtag_all_taps();
261         while (p)
262         {
263                 if (p->enabled)
264                         return p;
265                 p = p->next_tap;
266         }
267         return NULL;
268 }
269
270 const char *jtag_tap_name(const struct jtag_tap *tap)
271 {
272         return (tap == NULL) ? "(unknown)" : tap->dotted_name;
273 }
274
275
276 int jtag_register_event_callback(jtag_event_handler_t callback, void *priv)
277 {
278         struct jtag_event_callback **callbacks_p = &jtag_event_callbacks;
279
280         if (callback == NULL)
281         {
282                 return ERROR_INVALID_ARGUMENTS;
283         }
284
285         if (*callbacks_p)
286         {
287                 while ((*callbacks_p)->next)
288                         callbacks_p = &((*callbacks_p)->next);
289                 callbacks_p = &((*callbacks_p)->next);
290         }
291
292         (*callbacks_p) = malloc(sizeof(struct jtag_event_callback));
293         (*callbacks_p)->callback = callback;
294         (*callbacks_p)->priv = priv;
295         (*callbacks_p)->next = NULL;
296
297         return ERROR_OK;
298 }
299
300 int jtag_unregister_event_callback(jtag_event_handler_t callback, void *priv)
301 {
302         struct jtag_event_callback **p = &jtag_event_callbacks, *temp;
303
304         if (callback == NULL)
305         {
306                 return ERROR_INVALID_ARGUMENTS;
307         }
308
309         while (*p)
310         {
311                 if (((*p)->priv != priv) || ((*p)->callback != callback))
312                 {
313                         p = &(*p)->next;
314                         continue;
315                 }
316
317                 temp = *p;
318                 *p = (*p)->next;
319                 free(temp);
320         }
321
322         return ERROR_OK;
323 }
324
325 int jtag_call_event_callbacks(enum jtag_event event)
326 {
327         struct jtag_event_callback *callback = jtag_event_callbacks;
328
329         LOG_DEBUG("jtag event: %s", jtag_event_strings[event]);
330
331         while (callback)
332         {
333                 struct jtag_event_callback *next;
334
335                 /* callback may remove itself */
336                 next = callback->next;
337                 callback->callback(event, callback->priv);
338                 callback = next;
339         }
340
341         return ERROR_OK;
342 }
343
344 static void jtag_checks(void)
345 {
346         assert(jtag_trst == 0);
347 }
348
349 static void jtag_prelude(tap_state_t state)
350 {
351         jtag_checks();
352
353         assert(state != TAP_INVALID);
354
355         cmd_queue_cur_state = state;
356 }
357
358 void jtag_alloc_in_value32(struct scan_field *field)
359 {
360         interface_jtag_alloc_in_value32(field);
361 }
362
363 void jtag_add_ir_scan_noverify(struct jtag_tap *active, const struct scan_field *in_fields,
364                 tap_state_t state)
365 {
366         jtag_prelude(state);
367
368         int retval = interface_jtag_add_ir_scan(active, in_fields, state);
369         jtag_set_error(retval);
370 }
371
372 static void jtag_add_ir_scan_noverify_callback(struct jtag_tap *active, int dummy, const struct scan_field *in_fields,
373                 tap_state_t state)
374 {
375         jtag_add_ir_scan_noverify(active, in_fields, state);
376 }
377
378 void jtag_add_ir_scan(struct jtag_tap *active, struct scan_field *in_fields, tap_state_t state)
379 {
380         assert(state != TAP_RESET);
381
382         if (jtag_verify && jtag_verify_capture_ir)
383         {
384                 /* 8 x 32 bit id's is enough for all invocations */
385
386                 /* if we are to run a verification of the ir scan, we need to get the input back.
387                  * We may have to allocate space if the caller didn't ask for the input back.
388                  */
389                 in_fields->check_value = active->expected;
390                 in_fields->check_mask = active->expected_mask;
391                 jtag_add_scan_check(active, jtag_add_ir_scan_noverify_callback, 1, in_fields, state);
392         } else
393         {
394                 jtag_add_ir_scan_noverify(active, in_fields, state);
395         }
396 }
397
398 void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
399                 tap_state_t state)
400 {
401         assert(out_bits != NULL);
402         assert(state != TAP_RESET);
403
404         jtag_prelude(state);
405
406         int retval = interface_jtag_add_plain_ir_scan(
407                         num_bits, out_bits, in_bits, state);
408         jtag_set_error(retval);
409 }
410
411 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
412                 uint8_t *in_check_mask, int num_bits);
413
414 static int jtag_check_value_mask_callback(jtag_callback_data_t data0, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3)
415 {
416         return jtag_check_value_inner((uint8_t *)data0, (uint8_t *)data1, (uint8_t *)data2, (int)data3);
417 }
418
419 static void jtag_add_scan_check(struct jtag_tap *active, void (*jtag_add_scan)(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields, tap_state_t state),
420                 int in_num_fields, struct scan_field *in_fields, tap_state_t state)
421 {
422         for (int i = 0; i < in_num_fields; i++)
423         {
424                 struct scan_field *field = &in_fields[i];
425                 field->allocated = 0;
426                 field->modified = 0;
427                 if (field->check_value || field->in_value)
428                         continue;
429                 interface_jtag_add_scan_check_alloc(field);
430                 field->modified = 1;
431         }
432
433         jtag_add_scan(active, in_num_fields, in_fields, state);
434
435         for (int i = 0; i < in_num_fields; i++)
436         {
437                 if ((in_fields[i].check_value != NULL) && (in_fields[i].in_value != NULL))
438                 {
439                         /* this is synchronous for a minidriver */
440                         jtag_add_callback4(jtag_check_value_mask_callback, (jtag_callback_data_t)in_fields[i].in_value,
441                                 (jtag_callback_data_t)in_fields[i].check_value,
442                                 (jtag_callback_data_t)in_fields[i].check_mask,
443                                 (jtag_callback_data_t)in_fields[i].num_bits);
444                 }
445                 if (in_fields[i].allocated)
446                 {
447                         free(in_fields[i].in_value);
448                 }
449                 if (in_fields[i].modified)
450                 {
451                         in_fields[i].in_value = NULL;
452                 }
453         }
454 }
455
456 void jtag_add_dr_scan_check(struct jtag_tap *active, int in_num_fields, struct scan_field *in_fields, tap_state_t state)
457 {
458         if (jtag_verify)
459         {
460                 jtag_add_scan_check(active, jtag_add_dr_scan, in_num_fields, in_fields, state);
461         } else
462         {
463                 jtag_add_dr_scan(active, in_num_fields, in_fields, state);
464         }
465 }
466
467
468 void jtag_add_dr_scan(struct jtag_tap *active, int in_num_fields, const struct scan_field *in_fields,
469                 tap_state_t state)
470 {
471         assert(state != TAP_RESET);
472
473         jtag_prelude(state);
474
475         int retval;
476         retval = interface_jtag_add_dr_scan(active, in_num_fields, in_fields, state);
477         jtag_set_error(retval);
478 }
479
480 void jtag_add_plain_dr_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
481                 tap_state_t state)
482 {
483         assert(out_bits != NULL);
484         assert(state != TAP_RESET);
485
486         jtag_prelude(state);
487
488         int retval;
489         retval = interface_jtag_add_plain_dr_scan(num_bits, out_bits, in_bits, state);
490         jtag_set_error(retval);
491 }
492
493 void jtag_add_tlr(void)
494 {
495         jtag_prelude(TAP_RESET);
496         jtag_set_error(interface_jtag_add_tlr());
497
498         /* NOTE: order here matches TRST path in jtag_add_reset() */
499         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
500         jtag_notify_event(JTAG_TRST_ASSERTED);
501 }
502
503 /**
504  * If supported by the underlying adapter, this clocks a raw bit sequence
505  * onto TMS for switching betwen JTAG and SWD modes.
506  *
507  * DO NOT use this to bypass the integrity checks and logging provided
508  * by the jtag_add_pathmove() and jtag_add_statemove() calls.
509  *
510  * @param nbits How many bits to clock out.
511  * @param seq The bit sequence.  The LSB is bit 0 of seq[0].
512  * @param state The JTAG tap state to record on completion.  Use
513  *      TAP_INVALID to represent being in in SWD mode.
514  *
515  * @todo Update naming conventions to stop assuming everything is JTAG.
516  */
517 int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state state)
518 {
519         int retval;
520
521         if (!(jtag->supported & DEBUG_CAP_TMS_SEQ))
522                 return ERROR_JTAG_NOT_IMPLEMENTED;
523
524         jtag_checks();
525         cmd_queue_cur_state = state;
526
527         retval = interface_add_tms_seq(nbits, seq, state);
528         jtag_set_error(retval);
529         return retval;
530 }
531
532 void jtag_add_pathmove(int num_states, const tap_state_t *path)
533 {
534         tap_state_t cur_state = cmd_queue_cur_state;
535
536         /* the last state has to be a stable state */
537         if (!tap_is_state_stable(path[num_states - 1]))
538         {
539                 LOG_ERROR("BUG: TAP path doesn't finish in a stable state");
540                 jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
541                 return;
542         }
543
544         for (int i = 0; i < num_states; i++)
545         {
546                 if (path[i] == TAP_RESET)
547                 {
548                         LOG_ERROR("BUG: TAP_RESET is not a valid state for pathmove sequences");
549                         jtag_set_error(ERROR_JTAG_STATE_INVALID);
550                         return;
551                 }
552
553                 if (tap_state_transition(cur_state, true)  != path[i]
554                   && tap_state_transition(cur_state, false) != path[i])
555                 {
556                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
557                                         tap_state_name(cur_state), tap_state_name(path[i]));
558                         jtag_set_error(ERROR_JTAG_TRANSITION_INVALID);
559                         return;
560                 }
561                 cur_state = path[i];
562         }
563
564         jtag_checks();
565
566         jtag_set_error(interface_jtag_add_pathmove(num_states, path));
567         cmd_queue_cur_state = path[num_states - 1];
568 }
569
570 int jtag_add_statemove(tap_state_t goal_state)
571 {
572         tap_state_t cur_state = cmd_queue_cur_state;
573
574         if (goal_state != cur_state)
575         {
576                 LOG_DEBUG("cur_state=%s goal_state=%s",
577                         tap_state_name(cur_state),
578                         tap_state_name(goal_state));
579         }
580
581         /* If goal is RESET, be paranoid and force that that transition
582          * (e.g. five TCK cycles, TMS high).  Else trust "cur_state".
583          */
584         if (goal_state == TAP_RESET)
585                 jtag_add_tlr();
586         else if (goal_state == cur_state)
587                 /* nothing to do */ ;
588
589         else if (tap_is_state_stable(cur_state) && tap_is_state_stable(goal_state))
590         {
591                 unsigned tms_bits  = tap_get_tms_path(cur_state, goal_state);
592                 unsigned tms_count = tap_get_tms_path_len(cur_state, goal_state);
593                 tap_state_t moves[8];
594                 assert(tms_count < ARRAY_SIZE(moves));
595
596                 for (unsigned i = 0; i < tms_count; i++, tms_bits >>= 1)
597                 {
598                         bool bit = tms_bits & 1;
599
600                         cur_state = tap_state_transition(cur_state, bit);
601                         moves[i] = cur_state;
602                 }
603
604                 jtag_add_pathmove(tms_count, moves);
605         }
606         else if (tap_state_transition(cur_state, true)  == goal_state
607                 ||   tap_state_transition(cur_state, false) == goal_state)
608         {
609                 jtag_add_pathmove(1, &goal_state);
610         }
611
612         else
613                 return ERROR_FAIL;
614
615         return ERROR_OK;
616 }
617
618 void jtag_add_runtest(int num_cycles, tap_state_t state)
619 {
620         jtag_prelude(state);
621         jtag_set_error(interface_jtag_add_runtest(num_cycles, state));
622 }
623
624
625 void jtag_add_clocks(int num_cycles)
626 {
627         if (!tap_is_state_stable(cmd_queue_cur_state))
628         {
629                  LOG_ERROR("jtag_add_clocks() called with TAP in unstable state \"%s\"",
630                                  tap_state_name(cmd_queue_cur_state));
631                  jtag_set_error(ERROR_JTAG_NOT_STABLE_STATE);
632                  return;
633         }
634
635         if (num_cycles > 0)
636         {
637                 jtag_checks();
638                 jtag_set_error(interface_jtag_add_clocks(num_cycles));
639         }
640 }
641
642 void jtag_add_reset(int req_tlr_or_trst, int req_srst)
643 {
644         int trst_with_tlr = 0;
645         int new_srst = 0;
646         int new_trst = 0;
647
648         /* Without SRST, we must use target-specific JTAG operations
649          * on each target; callers should not be requesting SRST when
650          * that signal doesn't exist.
651          *
652          * RESET_SRST_PULLS_TRST is a board or chip level quirk, which
653          * can kick in even if the JTAG adapter can't drive TRST.
654          */
655         if (req_srst) {
656                 if (!(jtag_reset_config & RESET_HAS_SRST)) {
657                         LOG_ERROR("BUG: can't assert SRST");
658                         jtag_set_error(ERROR_FAIL);
659                         return;
660                 }
661                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) != 0
662                                 && !req_tlr_or_trst) {
663                         LOG_ERROR("BUG: can't assert only SRST");
664                         jtag_set_error(ERROR_FAIL);
665                         return;
666                 }
667                 new_srst = 1;
668         }
669
670         /* JTAG reset (entry to TAP_RESET state) can always be achieved
671          * using TCK and TMS; that may go through a TAP_{IR,DR}UPDATE
672          * state first.  TRST accelerates it, and bypasses those states.
673          *
674          * RESET_TRST_PULLS_SRST is a board or chip level quirk, which
675          * can kick in even if the JTAG adapter can't drive SRST.
676          */
677         if (req_tlr_or_trst) {
678                 if (!(jtag_reset_config & RESET_HAS_TRST))
679                         trst_with_tlr = 1;
680                 else if ((jtag_reset_config & RESET_TRST_PULLS_SRST) != 0
681                                 && !req_srst)
682                         trst_with_tlr = 1;
683                 else
684                         new_trst = 1;
685         }
686
687         /* Maybe change TRST and/or SRST signal state */
688         if (jtag_srst != new_srst || jtag_trst != new_trst) {
689                 int retval;
690
691                 retval = interface_jtag_add_reset(new_trst, new_srst);
692                 if (retval != ERROR_OK)
693                         jtag_set_error(retval);
694                 else
695                         retval = jtag_execute_queue();
696
697                 if (retval != ERROR_OK) {
698                         LOG_ERROR("TRST/SRST error");
699                         return;
700                 }
701         }
702
703         /* SRST resets everything hooked up to that signal */
704         if (jtag_srst != new_srst) {
705                 jtag_srst = new_srst;
706                 if (jtag_srst)
707                 {
708                         LOG_DEBUG("SRST line asserted");
709                         if (adapter_nsrst_assert_width)
710                                 jtag_add_sleep(adapter_nsrst_assert_width * 1000);
711                 }
712                 else {
713                         LOG_DEBUG("SRST line released");
714                         if (adapter_nsrst_delay)
715                                 jtag_add_sleep(adapter_nsrst_delay * 1000);
716                 }
717         }
718
719         /* Maybe enter the JTAG TAP_RESET state ...
720          *  - using only TMS, TCK, and the JTAG state machine
721          *  - or else more directly, using TRST
722          *
723          * TAP_RESET should be invisible to non-debug parts of the system.
724          */
725         if (trst_with_tlr) {
726                 LOG_DEBUG("JTAG reset with TLR instead of TRST");
727                 jtag_add_tlr();
728
729         } else if (jtag_trst != new_trst) {
730                 jtag_trst = new_trst;
731                 if (jtag_trst) {
732                         LOG_DEBUG("TRST line asserted");
733                         tap_set_state(TAP_RESET);
734                         if (jtag_ntrst_assert_width)
735                                 jtag_add_sleep(jtag_ntrst_assert_width * 1000);
736                 } else {
737                         LOG_DEBUG("TRST line released");
738                         if (jtag_ntrst_delay)
739                                 jtag_add_sleep(jtag_ntrst_delay * 1000);
740
741                         /* We just asserted nTRST, so we're now in TAP_RESET.
742                          * Inform possible listeners about this, now that
743                          * JTAG instructions and data can be shifted.  This
744                          * sequence must match jtag_add_tlr().
745                          */
746                         jtag_call_event_callbacks(JTAG_TRST_ASSERTED);
747                         jtag_notify_event(JTAG_TRST_ASSERTED);
748                 }
749         }
750 }
751
752 void jtag_add_sleep(uint32_t us)
753 {
754         /// @todo Here, keep_alive() appears to be a layering violation!!!
755         keep_alive();
756         jtag_set_error(interface_jtag_add_sleep(us));
757 }
758
759 static int jtag_check_value_inner(uint8_t *captured, uint8_t *in_check_value,
760                 uint8_t *in_check_mask, int num_bits)
761 {
762         int retval = ERROR_OK;
763         int compare_failed;
764
765         if (in_check_mask)
766                 compare_failed = buf_cmp_mask(captured, in_check_value, in_check_mask, num_bits);
767         else
768                 compare_failed = buf_cmp(captured, in_check_value, num_bits);
769
770         if (compare_failed) {
771                 char *captured_str, *in_check_value_str;
772                 int bits = (num_bits > DEBUG_JTAG_IOZ)
773                                 ? DEBUG_JTAG_IOZ
774                                 : num_bits;
775
776                 /* NOTE:  we've lost diagnostic context here -- 'which tap' */
777
778                 captured_str = buf_to_str(captured, bits, 16);
779                 in_check_value_str = buf_to_str(in_check_value, bits, 16);
780
781                 LOG_WARNING("Bad value '%s' captured during DR or IR scan:",
782                                 captured_str);
783                 LOG_WARNING(" check_value: 0x%s", in_check_value_str);
784
785                 free(captured_str);
786                 free(in_check_value_str);
787
788                 if (in_check_mask) {
789                         char *in_check_mask_str;
790
791                         in_check_mask_str = buf_to_str(in_check_mask, bits, 16);
792                         LOG_WARNING(" check_mask: 0x%s", in_check_mask_str);
793                         free(in_check_mask_str);
794                 }
795
796                 retval = ERROR_JTAG_QUEUE_FAILED;
797         }
798         return retval;
799 }
800
801 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask)
802 {
803         assert(field->in_value != NULL);
804
805         if (value == NULL)
806         {
807                 /* no checking to do */
808                 return;
809         }
810
811         jtag_execute_queue_noclear();
812
813         int retval = jtag_check_value_inner(field->in_value, value, mask, field->num_bits);
814         jtag_set_error(retval);
815 }
816
817
818
819 int default_interface_jtag_execute_queue(void)
820 {
821         if (NULL == jtag)
822         {
823                 LOG_ERROR("No JTAG interface configured yet.  "
824                         "Issue 'init' command in startup scripts "
825                         "before communicating with targets.");
826                 return ERROR_FAIL;
827         }
828
829         return jtag->execute_queue();
830 }
831
832 void jtag_execute_queue_noclear(void)
833 {
834         jtag_flush_queue_count++;
835         jtag_set_error(interface_jtag_execute_queue());
836
837         if (jtag_flush_queue_sleep > 0)
838         {
839                 /* For debug purposes it can be useful to test performance
840                  * or behavior when delaying after flushing the queue,
841                  * e.g. to simulate long roundtrip times.
842                  */
843                 usleep(jtag_flush_queue_sleep * 1000);
844         }
845 }
846
847 int jtag_get_flush_queue_count(void)
848 {
849         return jtag_flush_queue_count;
850 }
851
852 int jtag_execute_queue(void)
853 {
854         jtag_execute_queue_noclear();
855         return jtag_error_clear();
856 }
857
858 static int jtag_reset_callback(enum jtag_event event, void *priv)
859 {
860         struct jtag_tap *tap = priv;
861
862         if (event == JTAG_TRST_ASSERTED)
863         {
864                 tap->enabled = !tap->disabled_after_reset;
865
866                 /* current instruction is either BYPASS or IDCODE */
867                 buf_set_ones(tap->cur_instr, tap->ir_length);
868                 tap->bypass = 1;
869         }
870
871         return ERROR_OK;
872 }
873
874 void jtag_sleep(uint32_t us)
875 {
876         alive_sleep(us/1000);
877 }
878
879 /* Maximum number of enabled JTAG devices we expect in the scan chain,
880  * plus one (to detect garbage at the end).  Devices that don't support
881  * IDCODE take up fewer bits, possibly allowing a few more devices.
882  */
883 #define JTAG_MAX_CHAIN_SIZE 20
884
885 #define EXTRACT_MFG(X)  (((X) & 0xffe) >> 1)
886 #define EXTRACT_PART(X) (((X) & 0xffff000) >> 12)
887 #define EXTRACT_VER(X)  (((X) & 0xf0000000) >> 28)
888
889 /* A reserved manufacturer ID is used in END_OF_CHAIN_FLAG, so we
890  * know that no valid TAP will have it as an IDCODE value.
891  */
892 #define END_OF_CHAIN_FLAG       0x000000ff
893
894 /* a larger IR length than we ever expect to autoprobe */
895 #define JTAG_IRLEN_MAX          60
896
897 static int jtag_examine_chain_execute(uint8_t *idcode_buffer, unsigned num_idcode)
898 {
899         struct scan_field field = {
900                         .num_bits = num_idcode * 32,
901                         .out_value = idcode_buffer,
902                         .in_value = idcode_buffer,
903                 };
904
905         // initialize to the end of chain ID value
906         for (unsigned i = 0; i < JTAG_MAX_CHAIN_SIZE; i++)
907                 buf_set_u32(idcode_buffer, i * 32, 32, END_OF_CHAIN_FLAG);
908
909         jtag_add_plain_dr_scan(field.num_bits, field.out_value, field.in_value, TAP_DRPAUSE);
910         jtag_add_tlr();
911         return jtag_execute_queue();
912 }
913
914 static bool jtag_examine_chain_check(uint8_t *idcodes, unsigned count)
915 {
916         uint8_t zero_check = 0x0;
917         uint8_t one_check = 0xff;
918
919         for (unsigned i = 0; i < count * 4; i++)
920         {
921                 zero_check |= idcodes[i];
922                 one_check &= idcodes[i];
923         }
924
925         /* if there wasn't a single non-zero bit or if all bits were one,
926          * the scan is not valid.  We wrote a mix of both values; either
927          *
928          *  - There's a hardware issue (almost certainly):
929          *     + all-zeroes can mean a target stuck in JTAG reset
930          *     + all-ones tends to mean no target
931          *  - The scan chain is WAY longer than we can handle, *AND* either
932          *     + there are several hundreds of TAPs in bypass, or
933          *     + at least a few dozen TAPs all have an all-ones IDCODE
934          */
935         if (zero_check == 0x00 || one_check == 0xff)
936         {
937                 LOG_ERROR("JTAG scan chain interrogation failed: all %s",
938                                 (zero_check == 0x00) ? "zeroes" : "ones");
939                 LOG_ERROR("Check JTAG interface, timings, target power, etc.");
940                 return false;
941         }
942         return true;
943 }
944
945 static void jtag_examine_chain_display(enum log_levels level, const char *msg,
946                 const char *name, uint32_t idcode)
947 {
948         log_printf_lf(level, __FILE__, __LINE__, __FUNCTION__,
949                                   "JTAG tap: %s %16.16s: 0x%08x "
950                                   "(mfg: 0x%3.3x, part: 0x%4.4x, ver: 0x%1.1x)",
951                                   name, msg,
952                                   (unsigned int)idcode,
953                                   (unsigned int)EXTRACT_MFG(idcode),
954                                   (unsigned int)EXTRACT_PART(idcode),
955                                   (unsigned int)EXTRACT_VER(idcode));
956 }
957
958 static bool jtag_idcode_is_final(uint32_t idcode)
959 {
960         /*
961          * Some devices, such as AVR8, will output all 1's instead
962          * of TDI input value at end of chain.  Allow those values
963          * instead of failing.
964          */
965         return idcode == END_OF_CHAIN_FLAG || idcode == 0xFFFFFFFF;
966 }
967
968 /**
969  * This helper checks that remaining bits in the examined chain data are
970  * all as expected, but a single JTAG device requires only 64 bits to be
971  * read back correctly.  This can help identify and diagnose problems
972  * with the JTAG chain earlier, gives more helpful/explicit error messages.
973  * Returns TRUE iff garbage was found.
974  */
975 static bool jtag_examine_chain_end(uint8_t *idcodes, unsigned count, unsigned max)
976 {
977         bool triggered = false;
978         for (; count < max - 31; count += 32)
979         {
980                 uint32_t idcode = buf_get_u32(idcodes, count, 32);
981
982                 /* do not trigger the warning if the data looks good */
983                 if (jtag_idcode_is_final(idcode))
984                         continue;
985                 LOG_WARNING("Unexpected idcode after end of chain: %d 0x%08x",
986                                         count, (unsigned int)idcode);
987                 triggered = true;
988         }
989         return triggered;
990 }
991
992 static bool jtag_examine_chain_match_tap(const struct jtag_tap *tap)
993 {
994         uint32_t idcode = tap->idcode;
995
996         /* ignore expected BYPASS codes; warn otherwise */
997         if (0 == tap->expected_ids_cnt && !idcode)
998                 return true;
999
1000         /* optionally ignore the JTAG version field */
1001         uint32_t mask = tap->ignore_version ? ~(0xff << 24) : ~0;
1002
1003         idcode &= mask;
1004
1005         /* Loop over the expected identification codes and test for a match */
1006         unsigned ii, limit = tap->expected_ids_cnt;
1007
1008         for (ii = 0; ii < limit; ii++)
1009         {
1010                 uint32_t expected = tap->expected_ids[ii] & mask;
1011
1012                 if (idcode == expected)
1013                         return true;
1014
1015                 /* treat "-expected-id 0" as a "don't-warn" wildcard */
1016                 if (0 == tap->expected_ids[ii])
1017                         return true;
1018         }
1019
1020         /* If none of the expected ids matched, warn */
1021         jtag_examine_chain_display(LOG_LVL_WARNING, "UNEXPECTED",
1022                         tap->dotted_name, tap->idcode);
1023         for (ii = 0; ii < limit; ii++)
1024         {
1025                 char msg[32];
1026
1027                 snprintf(msg, sizeof(msg), "expected %u of %u", ii + 1, limit);
1028                 jtag_examine_chain_display(LOG_LVL_ERROR, msg,
1029                                 tap->dotted_name, tap->expected_ids[ii]);
1030         }
1031         return false;
1032 }
1033
1034 /* Try to examine chain layout according to IEEE 1149.1 Â§12
1035  * This is called a "blind interrogation" of the scan chain.
1036  */
1037 static int jtag_examine_chain(void)
1038 {
1039         uint8_t idcode_buffer[JTAG_MAX_CHAIN_SIZE * 4];
1040         unsigned bit_count;
1041         int retval;
1042         int tapcount = 0;
1043         bool autoprobe = false;
1044
1045         /* DR scan to collect BYPASS or IDCODE register contents.
1046          * Then make sure the scan data has both ones and zeroes.
1047          */
1048         LOG_DEBUG("DR scan interrogation for IDCODE/BYPASS");
1049         retval = jtag_examine_chain_execute(idcode_buffer, JTAG_MAX_CHAIN_SIZE);
1050         if (retval != ERROR_OK)
1051                 return retval;
1052         if (!jtag_examine_chain_check(idcode_buffer, JTAG_MAX_CHAIN_SIZE))
1053                 return ERROR_JTAG_INIT_FAILED;
1054
1055         /* point at the 1st tap */
1056         struct jtag_tap *tap = jtag_tap_next_enabled(NULL);
1057
1058         if (!tap)
1059                 autoprobe = true;
1060
1061         for (bit_count = 0;
1062                         tap && bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31;
1063                         tap = jtag_tap_next_enabled(tap))
1064         {
1065                 uint32_t idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1066
1067                 if ((idcode & 1) == 0)
1068                 {
1069                         /* Zero for LSB indicates a device in bypass */
1070                         LOG_INFO("TAP %s does not have IDCODE",
1071                                         tap->dotted_name);
1072                         idcode = 0;
1073                         tap->hasidcode = false;
1074
1075                         bit_count += 1;
1076                 }
1077                 else
1078                 {
1079                         /* Friendly devices support IDCODE */
1080                         tap->hasidcode = true;
1081                         jtag_examine_chain_display(LOG_LVL_INFO,
1082                                         "tap/device found",
1083                                         tap->dotted_name, idcode);
1084
1085                         bit_count += 32;
1086                 }
1087                 tap->idcode = idcode;
1088
1089                 /* ensure the TAP ID matches what was expected */
1090                 if (!jtag_examine_chain_match_tap(tap))
1091                         retval = ERROR_JTAG_INIT_SOFT_FAIL;
1092         }
1093
1094         /* Fail if too many TAPs were enabled for us to verify them all. */
1095         if (tap) {
1096                 LOG_ERROR("Too many TAPs enabled; '%s' ignored.",
1097                                 tap->dotted_name);
1098                 return ERROR_JTAG_INIT_FAILED;
1099         }
1100
1101         /* if autoprobing, the tap list is still empty ... populate it! */
1102         while (autoprobe && bit_count < (JTAG_MAX_CHAIN_SIZE * 32) - 31) {
1103                 uint32_t idcode;
1104                 char buf[12];
1105
1106                 /* Is there another TAP? */
1107                 idcode = buf_get_u32(idcode_buffer, bit_count, 32);
1108                 if (jtag_idcode_is_final(idcode))
1109                         break;
1110
1111                 /* Default everything in this TAP except IR length.
1112                  *
1113                  * REVISIT create a jtag_alloc(chip, tap) routine, and
1114                  * share it with jim_newtap_cmd().
1115                  */
1116                 tap = calloc(1, sizeof *tap);
1117                 if (!tap)
1118                         return ERROR_FAIL;
1119
1120                 sprintf(buf, "auto%d", tapcount++);
1121                 tap->chip = strdup(buf);
1122                 tap->tapname = strdup("tap");
1123
1124                 sprintf(buf, "%s.%s", tap->chip, tap->tapname);
1125                 tap->dotted_name = strdup(buf);
1126
1127                 /* tap->ir_length == 0 ... signifying irlen autoprobe */
1128                 tap->ir_capture_mask = 0x03;
1129                 tap->ir_capture_value = 0x01;
1130
1131                 tap->enabled = true;
1132
1133                 if ((idcode & 1) == 0) {
1134                         bit_count += 1;
1135                         tap->hasidcode = false;
1136                 } else {
1137                         bit_count += 32;
1138                         tap->hasidcode = true;
1139                         tap->idcode = idcode;
1140
1141                         tap->expected_ids_cnt = 1;
1142                         tap->expected_ids = malloc(sizeof(uint32_t));
1143                         tap->expected_ids[0] = idcode;
1144                 }
1145
1146                 LOG_WARNING("AUTO %s - use \"jtag newtap "
1147                                 "%s %s -expected-id 0x%8.8" PRIx32 " ...\"",
1148                                 tap->dotted_name, tap->chip, tap->tapname,
1149                                 tap->idcode);
1150
1151                 jtag_tap_init(tap);
1152         }
1153
1154         /* After those IDCODE or BYPASS register values should be
1155          * only the data we fed into the scan chain.
1156          */
1157         if (jtag_examine_chain_end(idcode_buffer, bit_count,
1158                         8 * sizeof(idcode_buffer))) {
1159                 LOG_ERROR("double-check your JTAG setup (interface, "
1160                                 "speed, missing TAPs, ...)");
1161                 return ERROR_JTAG_INIT_FAILED;
1162         }
1163
1164         /* Return success or, for backwards compatibility if only
1165          * some IDCODE values mismatched, a soft/continuable fault.
1166          */
1167         return retval;
1168 }
1169
1170 /*
1171  * Validate the date loaded by entry to the Capture-IR state, to help
1172  * find errors related to scan chain configuration (wrong IR lengths)
1173  * or communication.
1174  *
1175  * Entry state can be anything.  On non-error exit, all TAPs are in
1176  * bypass mode.  On error exits, the scan chain is reset.
1177  */
1178 static int jtag_validate_ircapture(void)
1179 {
1180         struct jtag_tap *tap;
1181         int total_ir_length = 0;
1182         uint8_t *ir_test = NULL;
1183         struct scan_field field;
1184         int val;
1185         int chain_pos = 0;
1186         int retval;
1187
1188         /* when autoprobing, accomodate huge IR lengths */
1189         for (tap = NULL, total_ir_length = 0;
1190                         (tap = jtag_tap_next_enabled(tap)) != NULL;
1191                         total_ir_length += tap->ir_length) {
1192                 if (tap->ir_length == 0)
1193                         total_ir_length += JTAG_IRLEN_MAX;
1194         }
1195
1196         /* increase length to add 2 bit sentinel after scan */
1197         total_ir_length += 2;
1198
1199         ir_test = malloc(DIV_ROUND_UP(total_ir_length, 8));
1200         if (ir_test == NULL)
1201                 return ERROR_FAIL;
1202
1203         /* after this scan, all TAPs will capture BYPASS instructions */
1204         buf_set_ones(ir_test, total_ir_length);
1205
1206         field.num_bits = total_ir_length;
1207         field.out_value = ir_test;
1208         field.in_value = ir_test;
1209
1210         jtag_add_plain_ir_scan(field.num_bits, field.out_value, field.in_value, TAP_IDLE);
1211
1212         LOG_DEBUG("IR capture validation scan");
1213         retval = jtag_execute_queue();
1214         if (retval != ERROR_OK)
1215                 goto done;
1216
1217         tap = NULL;
1218         chain_pos = 0;
1219
1220         for (;;) {
1221                 tap = jtag_tap_next_enabled(tap);
1222                 if (tap == NULL) {
1223                         break;
1224                 }
1225
1226                 /* If we're autoprobing, guess IR lengths.  They must be at
1227                  * least two bits.  Guessing will fail if (a) any TAP does
1228                  * not conform to the JTAG spec; or (b) when the upper bits
1229                  * captured from some conforming TAP are nonzero.  Or if
1230                  * (c) an IR length is longer than 32 bits -- which is only
1231                  * an implementation limit, which could someday be raised.
1232                  *
1233                  * REVISIT optimization:  if there's a *single* TAP we can
1234                  * lift restrictions (a) and (b) by scanning a recognizable
1235                  * pattern before the all-ones BYPASS.  Check for where the
1236                  * pattern starts in the result, instead of an 0...01 value.
1237                  *
1238                  * REVISIT alternative approach: escape to some tcl code
1239                  * which could provide more knowledge, based on IDCODE; and
1240                  * only guess when that has no success.
1241                  */
1242                 if (tap->ir_length == 0) {
1243                         tap->ir_length = 2;
1244                         while ((val = buf_get_u32(ir_test, chain_pos,
1245                                                 tap->ir_length + 1)) == 1
1246                                         && tap->ir_length <= 32) {
1247                                 tap->ir_length++;
1248                         }
1249                         LOG_WARNING("AUTO %s - use \"... -irlen %d\"",
1250                                         jtag_tap_name(tap), tap->ir_length);
1251                 }
1252
1253                 /* Validate the two LSBs, which must be 01 per JTAG spec.
1254                  *
1255                  * Or ... more bits could be provided by TAP declaration.
1256                  * Plus, some taps (notably in i.MX series chips) violate
1257                  * this part of the JTAG spec, so their capture mask/value
1258                  * attributes might disable this test.
1259                  */
1260                 val = buf_get_u32(ir_test, chain_pos, tap->ir_length);
1261                 if ((val & tap->ir_capture_mask) != tap->ir_capture_value) {
1262                         LOG_ERROR("%s: IR capture error; saw 0x%0*x not 0x%0*x",
1263                                         jtag_tap_name(tap),
1264                                         (tap->ir_length + 7) / tap->ir_length,
1265                                         val,
1266                                         (tap->ir_length + 7) / tap->ir_length,
1267                                         (unsigned) tap->ir_capture_value);
1268
1269                         retval = ERROR_JTAG_INIT_FAILED;
1270                         goto done;
1271                 }
1272                 LOG_DEBUG("%s: IR capture 0x%0*x", jtag_tap_name(tap),
1273                                 (tap->ir_length + 7) / tap->ir_length, val);
1274                 chain_pos += tap->ir_length;
1275         }
1276
1277         /* verify the '11' sentinel we wrote is returned at the end */
1278         val = buf_get_u32(ir_test, chain_pos, 2);
1279         if (val != 0x3)
1280         {
1281                 char *cbuf = buf_to_str(ir_test, total_ir_length, 16);
1282
1283                 LOG_ERROR("IR capture error at bit %d, saw 0x%s not 0x...3",
1284                                 chain_pos, cbuf);
1285                 free(cbuf);
1286                 retval = ERROR_JTAG_INIT_FAILED;
1287         }
1288
1289 done:
1290         free(ir_test);
1291         if (retval != ERROR_OK) {
1292                 jtag_add_tlr();
1293                 jtag_execute_queue();
1294         }
1295         return retval;
1296 }
1297
1298
1299 void jtag_tap_init(struct jtag_tap *tap)
1300 {
1301         unsigned ir_len_bits;
1302         unsigned ir_len_bytes;
1303
1304         /* if we're autoprobing, cope with potentially huge ir_length */
1305         ir_len_bits = tap->ir_length ? : JTAG_IRLEN_MAX;
1306         ir_len_bytes = DIV_ROUND_UP(ir_len_bits, 8);
1307
1308         tap->expected = calloc(1, ir_len_bytes);
1309         tap->expected_mask = calloc(1, ir_len_bytes);
1310         tap->cur_instr = malloc(ir_len_bytes);
1311
1312         /// @todo cope better with ir_length bigger than 32 bits
1313         if (ir_len_bits > 32)
1314                 ir_len_bits = 32;
1315
1316         buf_set_u32(tap->expected, 0, ir_len_bits, tap->ir_capture_value);
1317         buf_set_u32(tap->expected_mask, 0, ir_len_bits, tap->ir_capture_mask);
1318
1319         // TAP will be in bypass mode after jtag_validate_ircapture()
1320         tap->bypass = 1;
1321         buf_set_ones(tap->cur_instr, tap->ir_length);
1322
1323         // register the reset callback for the TAP
1324         jtag_register_event_callback(&jtag_reset_callback, tap);
1325
1326         LOG_DEBUG("Created Tap: %s @ abs position %d, "
1327                         "irlen %d, capture: 0x%x mask: 0x%x", tap->dotted_name,
1328                                 tap->abs_chain_position, tap->ir_length,
1329                                 (unsigned) tap->ir_capture_value,
1330                                 (unsigned) tap->ir_capture_mask);
1331         jtag_tap_add(tap);
1332 }
1333
1334 void jtag_tap_free(struct jtag_tap *tap)
1335 {
1336         jtag_unregister_event_callback(&jtag_reset_callback, tap);
1337
1338         /// @todo is anything missing? no memory leaks please
1339         free((void *)tap->expected);
1340         free((void *)tap->expected_ids);
1341         free((void *)tap->chip);
1342         free((void *)tap->tapname);
1343         free((void *)tap->dotted_name);
1344         free(tap);
1345 }
1346
1347 /**
1348  * Do low-level setup like initializing registers, output signals,
1349  * and clocking.
1350  */
1351 int adapter_init(struct command_context *cmd_ctx)
1352 {
1353         if (jtag)
1354                 return ERROR_OK;
1355
1356         if (!jtag_interface)
1357         {
1358                 /* nothing was previously specified by "interface" command */
1359                 LOG_ERROR("Debug Adapter has to be specified, "
1360                         "see \"interface\" command");
1361                 return ERROR_JTAG_INVALID_INTERFACE;
1362         }
1363
1364         jtag = jtag_interface;
1365         if (jtag_interface->init() != ERROR_OK)
1366         {
1367                 jtag = NULL;
1368                 return ERROR_JTAG_INIT_FAILED;
1369         }
1370
1371         /* LEGACY SUPPORT ... adapter drivers  must declare what
1372          * transports they allow.  Until they all do so, assume
1373          * the legacy drivers are JTAG-only
1374          */
1375         if (!transports_are_declared()) {
1376                 LOG_ERROR("Adapter driver '%s' did not declare "
1377                         "which transports it allows; assuming "
1378                         "JTAG-only", jtag->name);
1379                 int retval = allow_transports(cmd_ctx, jtag_only);
1380                 if (retval != ERROR_OK)
1381                         return retval;
1382         }
1383
1384         int requested_khz = jtag_get_speed_khz();
1385         int actual_khz = requested_khz;
1386         int jtag_speed_var;
1387         int retval = jtag_get_speed(&jtag_speed_var);
1388         if (retval != ERROR_OK)
1389                 return retval;
1390         retval = jtag_get_speed_readable(&actual_khz);
1391         if (ERROR_OK != retval)
1392                 LOG_INFO("adapter-specific clock speed value %d", jtag_speed_var);
1393         else if (actual_khz)
1394         {
1395                 /* Adaptive clocking -- JTAG-specific */
1396                 if ((CLOCK_MODE_RCLK == clock_mode)
1397                         || ((CLOCK_MODE_KHZ == clock_mode) && !requested_khz))
1398                 {
1399                         LOG_INFO("RCLK (adaptive clock speed) not supported - fallback to %d kHz"
1400                                 , actual_khz);
1401                 }
1402                 else
1403                         LOG_INFO("clock speed %d kHz", actual_khz);
1404         }
1405         else
1406                 LOG_INFO("RCLK (adaptive clock speed)");
1407
1408         return ERROR_OK;
1409 }
1410
1411 int jtag_init_inner(struct command_context *cmd_ctx)
1412 {
1413         struct jtag_tap *tap;
1414         int retval;
1415         bool issue_setup = true;
1416
1417         LOG_DEBUG("Init JTAG chain");
1418
1419         tap = jtag_tap_next_enabled(NULL);
1420         if (tap == NULL) {
1421                 /* Once JTAG itself is properly set up, and the scan chain
1422                  * isn't absurdly large, IDCODE autoprobe should work fine.
1423                  *
1424                  * But ... IRLEN autoprobe can fail even on systems which
1425                  * are fully conformant to JTAG.  Also, JTAG setup can be
1426                  * quite finicky on some systems.
1427                  *
1428                  * REVISIT: if TAP autoprobe works OK, then in many cases
1429                  * we could escape to tcl code and set up targets based on
1430                  * the TAP's IDCODE values.
1431                  */
1432                 LOG_WARNING("There are no enabled taps.  "
1433                                 "AUTO PROBING MIGHT NOT WORK!!");
1434
1435                 /* REVISIT default clock will often be too fast ... */
1436         }
1437
1438         jtag_add_tlr();
1439         if ((retval = jtag_execute_queue()) != ERROR_OK)
1440                 return retval;
1441
1442         /* Examine DR values first.  This discovers problems which will
1443          * prevent communication ... hardware issues like TDO stuck, or
1444          * configuring the wrong number of (enabled) TAPs.
1445          */
1446         retval = jtag_examine_chain();
1447         switch (retval) {
1448         case ERROR_OK:
1449                 /* complete success */
1450                 break;
1451         default:
1452                 /* For backward compatibility reasons, try coping with
1453                  * configuration errors involving only ID mismatches.
1454                  * We might be able to talk to the devices.
1455                  *
1456                  * Also the device might be powered down during startup.
1457                  *
1458                  * After OpenOCD starts, we can try to power on the device
1459                  * and run a reset.
1460                  */
1461                 LOG_ERROR("Trying to use configured scan chain anyway...");
1462                 issue_setup = false;
1463                 break;
1464         }
1465
1466         /* Now look at IR values.  Problems here will prevent real
1467          * communication.  They mostly mean that the IR length is
1468          * wrong ... or that the IR capture value is wrong.  (The
1469          * latter is uncommon, but easily worked around:  provide
1470          * ircapture/irmask values during TAP setup.)
1471          */
1472         retval = jtag_validate_ircapture();
1473         if (retval != ERROR_OK)
1474         {
1475                 /* The target might be powered down. The user
1476                  * can power it up and reset it after firing
1477                  * up OpenOCD.
1478                  */
1479                 issue_setup = false;
1480         }
1481
1482         if (issue_setup)
1483                 jtag_notify_event(JTAG_TAP_EVENT_SETUP);
1484         else
1485                 LOG_WARNING("Bypassing JTAG setup events due to errors");
1486
1487
1488         return ERROR_OK;
1489 }
1490
1491 int adapter_quit(void)
1492 {
1493         if (!jtag || !jtag->quit)
1494                 return ERROR_OK;
1495
1496         // close the JTAG interface
1497         int result = jtag->quit();
1498         if (ERROR_OK != result)
1499                 LOG_ERROR("failed: %d", result);
1500
1501         return ERROR_OK;
1502 }
1503
1504
1505 int jtag_init_reset(struct command_context *cmd_ctx)
1506 {
1507         int retval;
1508
1509         if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
1510                 return retval;
1511
1512         LOG_DEBUG("Initializing with hard TRST+SRST reset");
1513
1514         /*
1515          * This procedure is used by default when OpenOCD triggers a reset.
1516          * It's now done through an overridable Tcl "init_reset" wrapper.
1517          *
1518          * This started out as a more powerful "get JTAG working" reset than
1519          * jtag_init_inner(), applying TRST because some chips won't activate
1520          * JTAG without a TRST cycle (presumed to be async, though some of
1521          * those chips synchronize JTAG activation using TCK).
1522          *
1523          * But some chips only activate JTAG as part of an SRST cycle; SRST
1524          * got mixed in.  So it became a hard reset routine, which got used
1525          * in more places, and which coped with JTAG reset being forced as
1526          * part of SRST (srst_pulls_trst).
1527          *
1528          * And even more corner cases started to surface:  TRST and/or SRST
1529          * assertion timings matter; some chips need other JTAG operations;
1530          * TRST/SRST sequences can need to be different from these, etc.
1531          *
1532          * Systems should override that wrapper to support system-specific
1533          * requirements that this not-fully-generic code doesn't handle.
1534          *
1535          * REVISIT once Tcl code can read the reset_config modes, this won't
1536          * need to be a C routine at all...
1537          */
1538         jtag_add_reset(1, 0); /* TAP_RESET, using TMS+TCK or TRST */
1539         if (jtag_reset_config & RESET_HAS_SRST)
1540         {
1541                 jtag_add_reset(1, 1);
1542                 if ((jtag_reset_config & RESET_SRST_PULLS_TRST) == 0)
1543                         jtag_add_reset(0, 1);
1544         }
1545         jtag_add_reset(0, 0);
1546         if ((retval = jtag_execute_queue()) != ERROR_OK)
1547                 return retval;
1548
1549         /* Check that we can communication on the JTAG chain + eventually we want to
1550          * be able to perform enumeration only after OpenOCD has started
1551          * telnet and GDB server
1552          *
1553          * That would allow users to more easily perform any magic they need to before
1554          * reset happens.
1555          */
1556         return jtag_init_inner(cmd_ctx);
1557 }
1558
1559 int jtag_init(struct command_context *cmd_ctx)
1560 {
1561         int retval;
1562
1563         if ((retval = adapter_init(cmd_ctx)) != ERROR_OK)
1564                 return retval;
1565
1566         /* guard against oddball hardware: force resets to be inactive */
1567         jtag_add_reset(0, 0);
1568         if ((retval = jtag_execute_queue()) != ERROR_OK)
1569                 return retval;
1570
1571         if (Jim_Eval_Named(cmd_ctx->interp, "jtag_init", __FILE__, __LINE__) != JIM_OK)
1572                 return ERROR_FAIL;
1573
1574         return ERROR_OK;
1575 }
1576
1577 unsigned jtag_get_speed_khz(void)
1578 {
1579         return speed_khz;
1580 }
1581
1582 static int adapter_khz_to_speed(unsigned khz, int* speed)
1583 {
1584         LOG_DEBUG("convert khz to interface specific speed value");
1585         speed_khz = khz;
1586         if (jtag != NULL)
1587         {
1588                 LOG_DEBUG("have interface set up");
1589                 int speed_div1;
1590                 int retval = jtag->khz(jtag_get_speed_khz(), &speed_div1);
1591                 if (ERROR_OK != retval)
1592                 {
1593                         return retval;
1594                 }
1595                 *speed = speed_div1;
1596         }
1597         return ERROR_OK;
1598 }
1599
1600 static int jtag_rclk_to_speed(unsigned fallback_speed_khz, int* speed)
1601 {
1602         int retval = adapter_khz_to_speed(0, speed);
1603         if ((ERROR_OK != retval) && fallback_speed_khz)
1604         {
1605                 LOG_DEBUG("trying fallback speed...");
1606                 retval = adapter_khz_to_speed(fallback_speed_khz, speed);
1607         }
1608         return retval;
1609 }
1610
1611 static int jtag_set_speed(int speed)
1612 {
1613         jtag_speed = speed;
1614         /* this command can be called during CONFIG,
1615          * in which case jtag isn't initialized */
1616         return jtag ? jtag->speed(speed) : ERROR_OK;
1617 }
1618
1619 int jtag_config_khz(unsigned khz)
1620 {
1621         LOG_DEBUG("handle jtag khz");
1622         clock_mode = CLOCK_MODE_KHZ;
1623         int speed = 0;
1624         int retval = adapter_khz_to_speed(khz, &speed);
1625         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1626 }
1627
1628 int jtag_config_rclk(unsigned fallback_speed_khz)
1629 {
1630         LOG_DEBUG("handle jtag rclk");
1631         clock_mode = CLOCK_MODE_RCLK;
1632         rclk_fallback_speed_khz = fallback_speed_khz;
1633         int speed = 0;
1634         int retval = jtag_rclk_to_speed(fallback_speed_khz, &speed);
1635         return (ERROR_OK != retval) ? retval : jtag_set_speed(speed);
1636 }
1637
1638 int jtag_get_speed(int *speed)
1639 {
1640         switch(clock_mode)
1641         {
1642                 case CLOCK_MODE_SPEED:
1643                         *speed = jtag_speed;
1644                         break;
1645                 case CLOCK_MODE_KHZ:
1646                         adapter_khz_to_speed(jtag_get_speed_khz(), speed);
1647                         break;
1648                 case CLOCK_MODE_RCLK:
1649                         jtag_rclk_to_speed(rclk_fallback_speed_khz, speed);
1650                         break;
1651                 default:
1652                         LOG_ERROR("BUG: unknown jtag clock mode");
1653                         return ERROR_FAIL;
1654         }
1655         return ERROR_OK;
1656 }
1657
1658 int jtag_get_speed_readable(int *khz)
1659 {
1660         int jtag_speed_var;
1661         int retval = jtag_get_speed(&jtag_speed_var);
1662         if (retval != ERROR_OK)
1663                 return retval;
1664         return jtag ? jtag->speed_div(jtag_speed_var, khz) : ERROR_OK;
1665 }
1666
1667 void jtag_set_verify(bool enable)
1668 {
1669         jtag_verify = enable;
1670 }
1671
1672 bool jtag_will_verify()
1673 {
1674         return jtag_verify;
1675 }
1676
1677 void jtag_set_verify_capture_ir(bool enable)
1678 {
1679         jtag_verify_capture_ir = enable;
1680 }
1681
1682 bool jtag_will_verify_capture_ir()
1683 {
1684         return jtag_verify_capture_ir;
1685 }
1686
1687 int jtag_power_dropout(int *dropout)
1688 {
1689         if (jtag == NULL)
1690         {
1691                 /* TODO: as the jtag interface is not valid all
1692                  * we can do at the moment is exit OpenOCD */
1693                 LOG_ERROR("No Valid JTAG Interface Configured.");
1694                 exit(-1);
1695         }
1696         return jtag->power_dropout(dropout);
1697 }
1698
1699 int jtag_srst_asserted(int *srst_asserted)
1700 {
1701         return jtag->srst_asserted(srst_asserted);
1702 }
1703
1704 enum reset_types jtag_get_reset_config(void)
1705 {
1706         return jtag_reset_config;
1707 }
1708 void jtag_set_reset_config(enum reset_types type)
1709 {
1710         jtag_reset_config = type;
1711 }
1712
1713 int jtag_get_trst(void)
1714 {
1715         return jtag_trst;
1716 }
1717 int jtag_get_srst(void)
1718 {
1719         return jtag_srst;
1720 }
1721
1722 void jtag_set_nsrst_delay(unsigned delay)
1723 {
1724         adapter_nsrst_delay = delay;
1725 }
1726 unsigned jtag_get_nsrst_delay(void)
1727 {
1728         return adapter_nsrst_delay;
1729 }
1730 void jtag_set_ntrst_delay(unsigned delay)
1731 {
1732         jtag_ntrst_delay = delay;
1733 }
1734 unsigned jtag_get_ntrst_delay(void)
1735 {
1736         return jtag_ntrst_delay;
1737 }
1738
1739
1740 void jtag_set_nsrst_assert_width(unsigned delay)
1741 {
1742         adapter_nsrst_assert_width = delay;
1743 }
1744 unsigned jtag_get_nsrst_assert_width(void)
1745 {
1746         return adapter_nsrst_assert_width;
1747 }
1748 void jtag_set_ntrst_assert_width(unsigned delay)
1749 {
1750         jtag_ntrst_assert_width = delay;
1751 }
1752 unsigned jtag_get_ntrst_assert_width(void)
1753 {
1754         return jtag_ntrst_assert_width;
1755 }
1756
1757 static int jtag_select(struct command_context *ctx)
1758 {
1759         int retval;
1760
1761         /* NOTE:  interface init must already have been done.
1762          * That works with only C code ... no Tcl glue required.
1763          */
1764
1765         retval = jtag_register_commands(ctx);
1766
1767         if (retval != ERROR_OK)
1768                 return retval;
1769
1770         retval = svf_register_commands(ctx);
1771
1772         if (retval != ERROR_OK)
1773                 return retval;
1774
1775         return xsvf_register_commands(ctx);
1776 }
1777
1778 static struct transport jtag_transport = {
1779         .name = "jtag",
1780         .select = jtag_select,
1781         .init = jtag_init,
1782 };
1783
1784 static void jtag_constructor(void) __attribute__((constructor));
1785 static void jtag_constructor(void)
1786 {
1787         transport_register(&jtag_transport);
1788 }
1789
1790 /** Returns true if the current debug session
1791  * is using JTAG as its transport.
1792  */
1793 bool transport_is_jtag(void)
1794 {
1795         return get_current_transport() == &jtag_transport;
1796 }