Merge documentation for jtag_add_statemove from source into header block.
[openocd.git] / src / jtag / jtag.h
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 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifndef JTAG_H
24 #define JTAG_H
25
26 #include "binarybuffer.h"
27 #include "log.h"
28
29
30 #ifdef _DEBUG_JTAG_IO_
31 #define DEBUG_JTAG_IO(expr ...) LOG_DEBUG(expr)
32 #else
33 #define DEBUG_JTAG_IO(expr ...)
34 #endif
35
36 #ifndef DEBUG_JTAG_IOZ
37 #define DEBUG_JTAG_IOZ 64
38 #endif
39
40 /*-----<Macros>--------------------------------------------------*/
41
42 /**
43 * When given an array, compute its DIMension; in other words, the
44 * number of elements in the array
45 */
46 #define DIM(x) (sizeof(x)/sizeof((x)[0]))
47
48 /** Calculate the number of bytes required to hold @a n TAP scan bits */
49 #define TAP_SCAN_BYTES(n) CEIL(n, 8)
50
51 /*-----</Macros>-------------------------------------------------*/
52
53 /**
54 * Defines JTAG Test Access Port states.
55 *
56 * These definitions were gleaned from the ARM7TDMI-S Technical
57 * Reference Manual and validated against several other ARM core
58 * technical manuals. tap_get_tms_path() is sensitive to this numbering
59 * and ordering of the TAP states; furthermore, some interfaces require
60 * specific numbers be used, as they are handed-off directly to their
61 * hardware implementations.
62 */
63 typedef enum tap_state
64 {
65 #if BUILD_ECOSBOARD
66 /* These are the old numbers. Leave as-is for now... */
67 TAP_RESET = 0, TAP_IDLE = 8,
68 TAP_DRSELECT = 1, TAP_DRCAPTURE = 2, TAP_DRSHIFT = 3, TAP_DREXIT1 = 4,
69 TAP_DRPAUSE = 5, TAP_DREXIT2 = 6, TAP_DRUPDATE = 7,
70 TAP_IRSELECT = 9, TAP_IRCAPTURE = 10, TAP_IRSHIFT = 11, TAP_IREXIT1 = 12,
71 TAP_IRPAUSE = 13, TAP_IREXIT2 = 14, TAP_IRUPDATE = 15,
72
73 TAP_NUM_STATES = 16, TAP_INVALID = -1,
74 #else
75 /* Proper ARM recommended numbers */
76 TAP_DREXIT2 = 0x0,
77 TAP_DREXIT1 = 0x1,
78 TAP_DRSHIFT = 0x2,
79 TAP_DRPAUSE = 0x3,
80 TAP_IRSELECT = 0x4,
81 TAP_DRUPDATE = 0x5,
82 TAP_DRCAPTURE = 0x6,
83 TAP_DRSELECT = 0x7,
84 TAP_IREXIT2 = 0x8,
85 TAP_IREXIT1 = 0x9,
86 TAP_IRSHIFT = 0xa,
87 TAP_IRPAUSE = 0xb,
88 TAP_IDLE = 0xc,
89 TAP_IRUPDATE = 0xd,
90 TAP_IRCAPTURE = 0xe,
91 TAP_RESET = 0x0f,
92
93 TAP_NUM_STATES = 0x10,
94
95 TAP_INVALID = -1,
96 #endif
97 } tap_state_t;
98
99 /**
100 * Function tap_state_name
101 * Returns a string suitable for display representing the JTAG tap_state
102 */
103 const char* tap_state_name(tap_state_t state);
104
105 /// The current TAP state of the pending JTAG command queue.
106 extern tap_state_t cmd_queue_cur_state;
107
108 /**
109 * This structure defines a single scan field in the scan. It provides
110 * fields for the field's width and pointers to scan input and output
111 * values.
112 *
113 * In addition, this structure includes a value and mask that is used by
114 * jtag_add_dr_scan_check() to validate the value that was scanned out.
115 *
116 * The allocated, modified, and intmp fields are internal work space.
117 */
118 typedef struct scan_field_s
119 {
120 /// A pointer to the tap structure to which this field refers.
121 jtag_tap_t* tap;
122
123 /// The number of bits this field specifies (up to 32)
124 int num_bits;
125 /// A pointer to value to be scanned into the device
126 u8* out_value;
127 /// A pointer to a 32-bit memory location for data scanned out
128 u8* in_value;
129
130 /// The value used to check the data scanned out.
131 u8* check_value;
132 /// The mask to go with check_value
133 u8* check_mask;
134
135 /// in_value has been allocated for the queue
136 int allocated;
137 /// Indicates we modified the in_value.
138 int modified;
139 /// temporary storage for performing value checks synchronously
140 u8 intmp[4];
141 } scan_field_t;
142
143 typedef struct jtag_tap_event_action_s jtag_tap_event_action_t;
144
145 /* this is really: typedef jtag_tap_t */
146 /* But - the typedef is done in "types.h" */
147 /* due to "forward decloration reasons" */
148 struct jtag_tap_s
149 {
150 const char* chip;
151 const char* tapname;
152 const char* dotted_name;
153 int abs_chain_position;
154 /// Is this TAP enabled?
155 int enabled;
156 int ir_length; /**< size of instruction register */
157 u32 ir_capture_value;
158 u8* expected; /**< Capture-IR expected value */
159 u32 ir_capture_mask;
160 u8* expected_mask; /**< Capture-IR expected mask */
161 u32 idcode;
162 /**< device identification code */
163
164 /// Array of expected identification codes */
165 u32* expected_ids;
166 /// Number of expected identification codes
167 u8 expected_ids_cnt;
168
169 /// current instruction
170 u8* cur_instr;
171 /// Bypass register selected
172 int bypass;
173
174 jtag_tap_event_action_t *event_action;
175
176 jtag_tap_t* next_tap;
177 };
178 extern jtag_tap_t* jtag_all_taps(void);
179 extern const char *jtag_tap_name(const jtag_tap_t *tap);
180 extern jtag_tap_t* jtag_tap_by_string(const char* dotted_name);
181 extern jtag_tap_t* jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj* obj);
182 extern jtag_tap_t* jtag_tap_by_position(unsigned abs_position);
183 extern unsigned jtag_tap_count_enabled(void);
184 extern unsigned jtag_tap_count(void);
185
186 static __inline__ jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p)
187 {
188 if (p == NULL)
189 {
190 /* start at the head of list */
191 p = jtag_all_taps();
192 }
193 else
194 {
195 /* start *after* this one */
196 p = p->next_tap;
197 }
198 while (p)
199 {
200 if (p->enabled)
201 {
202 break;
203 }
204 else
205 {
206 p = p->next_tap;
207 }
208 }
209
210 return p;
211 }
212
213
214 enum reset_line_mode {
215 LINE_OPEN_DRAIN = 0x0,
216 LINE_PUSH_PULL = 0x1,
217 };
218
219 /*
220 * There are three cases when JTAG_TRST_ASSERTED callback is invoked. The
221 * event is invoked *after* TRST is asserted(or queued rather). It is illegal
222 * to communicate with the JTAG interface during the callback(as there is
223 * currently a queue being built).
224 *
225 * - TMS reset
226 * - SRST pulls TRST
227 * - TRST asserted
228 *
229 **/
230 enum jtag_event {
231 JTAG_TRST_ASSERTED
232 };
233
234 extern char* jtag_event_strings[];
235
236 enum jtag_tap_event {
237 JTAG_TAP_EVENT_ENABLE,
238 JTAG_TAP_EVENT_DISABLE
239 };
240
241 extern const Jim_Nvp nvp_jtag_tap_event[];
242
243 struct jtag_tap_event_action_s
244 {
245 enum jtag_tap_event event;
246 Jim_Obj* body;
247 jtag_tap_event_action_t* next;
248 };
249
250 extern int jtag_trst;
251 extern int jtag_srst;
252
253 typedef struct jtag_event_callback_s
254 {
255 int (*callback)(enum jtag_event event, void* priv);
256 void* priv;
257 struct jtag_event_callback_s* next;
258 } jtag_event_callback_t;
259
260 extern jtag_event_callback_t* jtag_event_callbacks;
261
262 extern int jtag_speed;
263 extern int jtag_speed_post_reset;
264
265 enum reset_types {
266 RESET_NONE = 0x0,
267 RESET_HAS_TRST = 0x1,
268 RESET_HAS_SRST = 0x2,
269 RESET_TRST_AND_SRST = 0x3,
270 RESET_SRST_PULLS_TRST = 0x4,
271 RESET_TRST_PULLS_SRST = 0x8,
272 RESET_TRST_OPEN_DRAIN = 0x10,
273 RESET_SRST_PUSH_PULL = 0x20,
274 };
275
276 extern enum reset_types jtag_reset_config;
277
278 /**
279 * Initialize interface upon startup. Return a successful no-op upon
280 * subsequent invocations.
281 */
282 extern int jtag_interface_init(struct command_context_s* cmd_ctx);
283
284 /// Shutdown the JTAG interface upon program exit.
285 extern int jtag_interface_quit(void);
286
287 /**
288 * Initialize JTAG chain using only a RESET reset. If init fails,
289 * try reset + init.
290 */
291 extern int jtag_init(struct command_context_s* cmd_ctx);
292
293 /// reset, then initialize JTAG chain
294 extern int jtag_init_reset(struct command_context_s* cmd_ctx);
295 extern int jtag_register_commands(struct command_context_s* cmd_ctx);
296
297 /**
298 * @file
299 * The JTAG interface can be implemented with a software or hardware fifo.
300 *
301 * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states; however,
302 * TAP_DRSHIFT/IRSHIFT can be emulated as end states, by using longer
303 * scans.
304 *
305 * Code that is relatively insensitive to the path taken through state
306 * machine (as long as it is JTAG compliant) can use @a endstate for
307 * jtag_add_xxx_scan(). Otherwise, the pause state must be specified as
308 * end state and a subsequent jtag_add_pathmove() must be issued.
309 */
310
311 /**
312 * Generate an IR SCAN with a list of scan fields with one entry for
313 * each enabled TAP.
314 *
315 * If the input field list contains an instruction value for a TAP then
316 * that is used otherwise the TAP is set to bypass.
317 *
318 * TAPs for which no fields are passed are marked as bypassed for
319 * subsequent DR SCANs.
320 *
321 */
322 extern void jtag_add_ir_scan(int num_fields, scan_field_t* fields, tap_state_t endstate);
323 /**
324 * The same as jtag_add_ir_scan except no verification is performed out
325 * the output values.
326 */
327 extern void jtag_add_ir_scan_noverify(int num_fields, const scan_field_t *fields, tap_state_t state);
328 /**
329 * Duplicate the scan fields passed into the function into an IR SCAN
330 * command. This function assumes that the caller handles extra fields
331 * for bypassed TAPs.
332 */
333 extern void jtag_add_plain_ir_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
334
335
336 /**
337 * Set in_value to point to 32 bits of memory to scan into. This
338 * function is a way to handle the case of synchronous and asynchronous
339 * JTAG queues.
340 *
341 * In the event of an asynchronous queue execution the queue buffer
342 * allocation method is used, for the synchronous case the temporary 32
343 * bits come from the input field itself.
344 */
345 extern void jtag_alloc_in_value32(scan_field_t *field);
346
347 /**
348 * Generate a DR SCAN using the fields passed to the function.
349 * For connected TAPs, the function checks in_fields and uses fields
350 * specified there. For bypassed TAPs, the function generates a dummy
351 * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
352 */
353 extern void jtag_add_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
354 /// A version of jtag_add_dr_scan() that uses the check_value/mask fields
355 extern void jtag_add_dr_scan_check(int num_fields, scan_field_t* fields, tap_state_t endstate);
356 /**
357 * Duplicate the scan fields passed into the function into a DR SCAN
358 * command. Unlike jtag_add_dr_scan(), this function assumes that the
359 * caller handles extra fields for bypassed TAPs.
360 */
361 extern void jtag_add_plain_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
362
363
364 /**
365 * Defines a simple JTAG callback that can allow conversions on data
366 * scanned in from an interface.
367 *
368 * This callback should only be used for conversion that cannot fail.
369 * For conversion types or checks that can fail, use the more complete
370 * variant: jtag_callback_t.
371 */
372 typedef void (*jtag_callback1_t)(u8 *in);
373
374 /// A simpler version of jtag_add_callback4().
375 extern void jtag_add_callback(jtag_callback1_t, u8 *in);
376
377
378 /**
379 * Defines the type of data passed to the jtag_callback_t interface.
380 * The underlying type must allow storing an @c int or pointer type.
381 */
382 typedef intptr_t jtag_callback_data_t;
383
384 /**
385 * Defines the interface of the JTAG callback mechanism.
386 *
387 * @param in the pointer to the data clocked in
388 * @param data1 An integer big enough to use as an @c int or a pointer.
389 * @param data2 An integer big enough to use as an @c int or a pointer.
390 * @param data3 An integer big enough to use as an @c int or a pointer.
391 * @returns an error code
392 */
393 typedef int (*jtag_callback_t)(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3);
394
395
396 /**
397 * This callback can be executed immediately the queue has been flushed.
398 *
399 * The JTAG queue can be executed synchronously or asynchronously.
400 * Typically for USB, the queue is executed asynchronously. For
401 * low-latency interfaces, the queue may be executed synchronously.
402 *
403 * The callback mechanism is very general and does not make many
404 * assumptions about what the callback does or what its arguments are.
405 * These callbacks are typically executed *after* the *entire* JTAG
406 * queue has been executed for e.g. USB interfaces, and they are
407 * guaranteeed to be invoked in the order that they were queued.
408 *
409 * If the execution of the queue fails before the callbacks, then --
410 * depending on driver implementation -- the callbacks may or may not be
411 * invoked. @todo Can we make this behavior consistent?
412 *
413 * The strange name is due to C's lack of overloading using function
414 * arguments.
415 *
416 * @param f The callback function to add.
417 * @param in Typically used to point to the data to operate on.
418 * Frequently this will be the data clocked in during a shift operation.
419 * @param data1 An integer big enough to use as an @c int or a pointer.
420 * @param data2 An integer big enough to use as an @c int or a pointer.
421 * @param data3 An integer big enough to use as an @c int or a pointer.
422 *
423 */
424 extern void jtag_add_callback4(jtag_callback_t f, u8 *in,
425 jtag_callback_data_t data1, jtag_callback_data_t data2,
426 jtag_callback_data_t data3);
427
428
429 /**
430 * Run a TAP_RESET reset where the end state is TAP_RESET,
431 * regardless of the start state.
432 */
433 extern void jtag_add_tlr(void);
434
435 /**
436 * Application code *must* assume that interfaces will
437 * implement transitions between states with different
438 * paths and path lengths through the state diagram. The
439 * path will vary across interface and also across versions
440 * of the same interface over time. Even if the OpenOCD code
441 * is unchanged, the actual path taken may vary over time
442 * and versions of interface firmware or PCB revisions.
443 *
444 * Use jtag_add_pathmove() when specific transition sequences
445 * are required.
446 *
447 * Do not use jtag_add_pathmove() unless you need to, but do use it
448 * if you have to.
449 *
450 * DANGER! If the target is dependent upon a particular sequence
451 * of transitions for things to work correctly(e.g. as a workaround
452 * for an errata that contradicts the JTAG standard), then pathmove
453 * must be used, even if some jtag interfaces happen to use the
454 * desired path. Worse, the jtag interface used for testing a
455 * particular implementation, could happen to use the "desired"
456 * path when transitioning to/from end
457 * state.
458 *
459 * A list of unambigious single clock state transitions, not
460 * all drivers can support this, but it is required for e.g.
461 * XScale and Xilinx support
462 *
463 * Note! TAP_RESET must not be used in the path!
464 *
465 * Note that the first on the list must be reachable
466 * via a single transition from the current state.
467 *
468 * All drivers are required to implement jtag_add_pathmove().
469 * However, if the pathmove sequence can not be precisely
470 * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
471 * must return an error. It is legal, but not recommended, that
472 * a driver returns an error in all cases for a pathmove if it
473 * can only implement a few transitions and therefore
474 * a partial implementation of pathmove would have little practical
475 * application.
476 *
477 * If an error occurs, jtag_error will contain one of these error codes:
478 * - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
479 * - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
480 * - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
481 * state transitions.
482 */
483 extern void jtag_add_pathmove(int num_states, const tap_state_t* path);
484
485 /**
486 * Goes to TAP_IDLE (if we're not already there), cycle
487 * precisely num_cycles in the TAP_IDLE state, after which move
488 * to @a endstate (unless it is also TAP_IDLE).
489 *
490 * @param num_cycles Number of cycles in TAP_IDLE state. This argument
491 * may be 0, in which case this routine will navigate to @a endstate
492 * via TAP_IDLE.
493 * @param endstate The final state.
494 */
495 extern void jtag_add_runtest(int num_cycles, tap_state_t endstate);
496
497 /**
498 * A reset of the TAP state machine can be requested.
499 *
500 * Whether tms or trst reset is used depends on the capabilities of
501 * the target and jtag interface(reset_config command configures this).
502 *
503 * srst can driver a reset of the TAP state machine and vice
504 * versa
505 *
506 * Application code may need to examine value of jtag_reset_config
507 * to determine the proper codepath
508 *
509 * DANGER! Even though srst drives trst, trst might not be connected to
510 * the interface, and it might actually be *harmful* to assert trst in this case.
511 *
512 * This is why combinations such as "reset_config srst_only srst_pulls_trst"
513 * are supported.
514 *
515 * only req_tlr_or_trst and srst can have a transition for a
516 * call as the effects of transitioning both at the "same time"
517 * are undefined, but when srst_pulls_trst or vice versa,
518 * then trst & srst *must* be asserted together.
519 */
520 extern void jtag_add_reset(int req_tlr_or_trst, int srst);
521
522
523 /**
524 * Function jtag_set_end_state
525 *
526 * Set a global variable to \a state if \a state != TAP_INVALID.
527 *
528 * Return the value of the global variable.
529 *
530 **/
531 extern tap_state_t jtag_set_end_state(tap_state_t state);
532 /**
533 * Function jtag_get_end_state
534 *
535 * Return the value of the global variable for end state
536 *
537 **/
538 extern tap_state_t jtag_get_end_state(void);
539 extern void jtag_add_sleep(u32 us);
540
541
542 /**
543 * Function jtag_add_stable_clocks
544 * first checks that the state in which the clocks are to be issued is
545 * stable, then queues up clock_count clocks for transmission.
546 */
547 void jtag_add_clocks(int num_cycles);
548
549
550 /**
551 * For software FIFO implementations, the queued commands can be executed
552 * during this call or earlier. A sw queue might decide to push out
553 * some of the jtag_add_xxx() operations once the queue is "big enough".
554 *
555 * This fn will return an error code if any of the prior jtag_add_xxx()
556 * calls caused a failure, e.g. check failure. Note that it does not
557 * matter if the operation was executed *before* jtag_execute_queue(),
558 * jtag_execute_queue() will still return an error code.
559 *
560 * All jtag_add_xxx() calls that have in_handler!=NULL will have been
561 * executed when this fn returns, but if what has been queued only
562 * clocks data out, without reading anything back, then JTAG could
563 * be running *after* jtag_execute_queue() returns. The API does
564 * not define a way to flush a hw FIFO that runs *after*
565 * jtag_execute_queue() returns.
566 *
567 * jtag_add_xxx() commands can either be executed immediately or
568 * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
569 */
570 extern int jtag_execute_queue(void);
571
572 /* same as jtag_execute_queue() but does not clear the error flag */
573 extern void jtag_execute_queue_noclear(void);
574
575 /**
576 * The jtag_error variable is set when an error occurs while executing
577 * the queue.
578 *
579 * This flag can also be set from application code, if an error happens
580 * during processing that should be reported during jtag_execute_queue().
581 *
582 * It is cleared by jtag_execute_queue().
583 */
584 extern int jtag_error;
585
586 static __inline__ void jtag_set_error(int error)
587 {
588 if ((error==ERROR_OK)||(jtag_error!=ERROR_OK))
589 {
590 /* keep first error */
591 return;
592 }
593 jtag_error=error;
594 }
595
596 /**
597 * Resets jtag_error to ERROR_OK, returning its previous value.
598 * @returns The previous value of @c jtag_error.
599 */
600 static inline int jtag_error_clear(void)
601 {
602 int temp = jtag_error;
603 jtag_error = ERROR_OK;
604 return temp;
605 }
606
607 /* can be implemented by hw+sw */
608 extern int jtag_power_dropout(int* dropout);
609 extern int jtag_srst_asserted(int* srst_asserted);
610
611 /* JTAG support functions */
612
613 /**
614 * Execute jtag queue and check value with an optional mask.
615 * @param field Pointer to scan field.
616 * @param value Pointer to scan value.
617 * @param mask Pointer to scan mask; may be NULL.
618 * @returns Nothing, but calls jtag_set_error() on any error.
619 */
620 extern void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask);
621
622 extern void jtag_sleep(u32 us);
623 extern int jtag_call_event_callbacks(enum jtag_event event);
624 extern int jtag_register_event_callback(int (* callback)(enum jtag_event event, void* priv), void* priv);
625
626 extern int jtag_verify_capture_ir;
627
628 void jtag_tap_handle_event(jtag_tap_t* tap, enum jtag_tap_event e);
629
630 /*
631 * The JTAG subsystem defines a number of error codes,
632 * using codes between -100 and -199.
633 */
634 #define ERROR_JTAG_INIT_FAILED (-100)
635 #define ERROR_JTAG_INVALID_INTERFACE (-101)
636 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
637 #define ERROR_JTAG_TRST_ASSERTED (-103)
638 #define ERROR_JTAG_QUEUE_FAILED (-104)
639 #define ERROR_JTAG_NOT_STABLE_STATE (-105)
640 #define ERROR_JTAG_DEVICE_ERROR (-107)
641 #define ERROR_JTAG_STATE_INVALID (-108)
642 #define ERROR_JTAG_TRANSITION_INVALID (-109)
643
644 /**
645 * jtag_add_dr_out() is a version of jtag_add_dr_scan() which
646 * only scans data out. It operates on 32 bit integers instead
647 * of 8 bit, which makes it a better impedance match with
648 * the calling code which often operate on 32 bit integers.
649 *
650 * Current or end_state can not be TAP_RESET. end_state can be TAP_INVALID
651 *
652 * num_bits[i] is the number of bits to clock out from value[i] LSB first.
653 *
654 * If the device is in bypass, then that is an error condition in
655 * the caller code that is not detected by this fn, whereas
656 * jtag_add_dr_scan() does detect it. Similarly if the device is not in
657 * bypass, data must be passed to it.
658 *
659 * If anything fails, then jtag_error will be set and jtag_execute() will
660 * return an error. There is no way to determine if there was a failure
661 * during this function call.
662 *
663 * This is an inline fn to speed up embedded hosts. Also note that
664 * interface_jtag_add_dr_out() can be a *small* inline function for
665 * embedded hosts.
666 *
667 * There is no jtag_add_dr_outin() version of this fn that also allows
668 * clocking data back in. Patches gladly accepted!
669 */
670 extern void jtag_add_dr_out(jtag_tap_t* tap,
671 int num_fields, const int* num_bits, const u32* value,
672 tap_state_t end_state);
673
674
675 /**
676 * jtag_add_statemove() moves from the current state to @a goal_state.
677 *
678 * @param goal_state The final TAP state.
679 * @return ERROR_OK on success, or an error code on failure.
680 *
681 * Moves from the current state to the goal \a state.
682 *
683 * This needs to be handled according to the xsvf spec, see the XSTATE
684 * command description. From the XSVF spec, pertaining to XSTATE:
685 *
686 * For special states known as stable states (Test-Logic-Reset,
687 * Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
688 * predefined TAP state paths when the starting state is a stable state
689 * and when the XSTATE specifies a new stable state. See the STATE
690 * command in the [Ref 5] for the TAP state paths between stable
691 * states.
692 *
693 * For non-stable states, XSTATE should specify a state that is only one
694 * TAP state transition distance from the current TAP state to avoid
695 * undefined TAP state paths. A sequence of multiple XSTATE commands can
696 * be issued to transition the TAP through a specific state path.
697 *
698 * @note Unless @c tms_bits holds a path that agrees with [Ref 5] in the
699 * above spec, then this code is not fully conformant to the xsvf spec.
700 * This puts a burden on tap_get_tms_path() function from the xsvf spec.
701 * If in doubt, you should confirm that that burden is being met.
702 *
703 * Otherwise, @a goal_state must be immediately reachable in one clock
704 * cycle, and does not need to be a stable state.
705 */
706 extern int jtag_add_statemove(tap_state_t goal_state);
707
708 /// @returns the number of times the scan queue has been flushed
709 int jtag_get_flush_queue_count(void);
710
711 void jtag_set_nsrst_delay(unsigned delay);
712 unsigned jtag_get_nsrst_delay(void);
713
714 void jtag_set_ntrst_delay(unsigned delay);
715 unsigned jtag_get_ntrst_delay(void);
716
717 void jtag_set_speed_khz(unsigned speed);
718 unsigned jtag_get_speed_khz(void);
719
720 void jtag_set_verify(bool enable);
721 bool jtag_will_verify(void);
722
723 #endif /* JTAG_H */

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)