Encapsulate the jtag_event_callback list; add helper functions if needed.
[fw/openocd] / 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 enum jtag_tap_event {
235         JTAG_TAP_EVENT_ENABLE,
236         JTAG_TAP_EVENT_DISABLE
237 };
238
239 struct jtag_tap_event_action_s
240 {
241         enum jtag_tap_event      event;
242         Jim_Obj*                 body;
243         jtag_tap_event_action_t* next;
244 };
245
246 /// @returns The current state of TRST.
247 int jtag_get_trst(void);
248 /// @returns The current state of SRST.
249 int jtag_get_srst(void);
250
251 typedef struct jtag_event_callback_s
252 {
253         int (*callback)(enum jtag_event event, void* priv);
254         void*                         priv;
255         struct jtag_event_callback_s* next;
256 } jtag_event_callback_t;
257
258 extern int jtag_speed;
259 extern int jtag_speed_post_reset;
260
261 enum reset_types {
262         RESET_NONE            = 0x0,
263         RESET_HAS_TRST        = 0x1,
264         RESET_HAS_SRST        = 0x2,
265         RESET_TRST_AND_SRST   = 0x3,
266         RESET_SRST_PULLS_TRST = 0x4,
267         RESET_TRST_PULLS_SRST = 0x8,
268         RESET_TRST_OPEN_DRAIN = 0x10,
269         RESET_SRST_PUSH_PULL  = 0x20,
270 };
271
272 extern enum reset_types jtag_reset_config;
273
274 /**
275  * Initialize interface upon startup.  Return a successful no-op upon
276  * subsequent invocations.
277  */
278 extern int  jtag_interface_init(struct command_context_s* cmd_ctx);
279
280 /// Shutdown the JTAG interface upon program exit.
281 extern int  jtag_interface_quit(void);
282
283 /**
284  * Initialize JTAG chain using only a RESET reset. If init fails,
285  * try reset + init.
286  */
287 extern int  jtag_init(struct command_context_s* cmd_ctx);
288
289 /// reset, then initialize JTAG chain
290 extern int  jtag_init_reset(struct command_context_s* cmd_ctx);
291 extern int  jtag_register_commands(struct command_context_s* cmd_ctx);
292
293 /**
294  * @file
295  * The JTAG interface can be implemented with a software or hardware fifo.
296  *
297  * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states; however,
298  * TAP_DRSHIFT/IRSHIFT can be emulated as end states, by using longer
299  * scans.
300  *
301  * Code that is relatively insensitive to the path taken through state
302  * machine (as long as it is JTAG compliant) can use @a endstate for
303  * jtag_add_xxx_scan(). Otherwise, the pause state must be specified as
304  * end state and a subsequent jtag_add_pathmove() must be issued.
305  */
306
307 /**
308  * Generate an IR SCAN with a list of scan fields with one entry for
309  * each enabled TAP.
310  *
311  * If the input field list contains an instruction value for a TAP then
312  * that is used otherwise the TAP is set to bypass.
313  *
314  * TAPs for which no fields are passed are marked as bypassed for
315  * subsequent DR SCANs.
316  *
317  */
318 extern void jtag_add_ir_scan(int num_fields, scan_field_t* fields, tap_state_t endstate);
319 /**
320  * The same as jtag_add_ir_scan except no verification is performed out
321  * the output values.
322  */
323 extern void jtag_add_ir_scan_noverify(int num_fields, const scan_field_t *fields, tap_state_t state);
324 /**
325  * Duplicate the scan fields passed into the function into an IR SCAN
326  * command.  This function assumes that the caller handles extra fields
327  * for bypassed TAPs.
328  */
329 extern void jtag_add_plain_ir_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
330
331
332 /**
333  * Set in_value to point to 32 bits of memory to scan into. This
334  * function is a way to handle the case of synchronous and asynchronous
335  * JTAG queues.
336  *
337  * In the event of an asynchronous queue execution the queue buffer
338  * allocation method is used, for the synchronous case the temporary 32
339  * bits come from the input field itself.
340  */
341 extern void jtag_alloc_in_value32(scan_field_t *field);
342
343 /**
344  * Generate a DR SCAN using the fields passed to the function.
345  * For connected TAPs, the function checks in_fields and uses fields
346  * specified there.  For bypassed TAPs, the function generates a dummy
347  * 1-bit field.  The bypass status of TAPs is set by jtag_add_ir_scan().
348  */
349 extern void jtag_add_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
350 /// A version of jtag_add_dr_scan() that uses the check_value/mask fields
351 extern void jtag_add_dr_scan_check(int num_fields, scan_field_t* fields, tap_state_t endstate);
352 /**
353  * Duplicate the scan fields passed into the function into a DR SCAN
354  * command.  Unlike jtag_add_dr_scan(), this function assumes that the
355  * caller handles extra fields for bypassed TAPs.
356  */
357 extern void jtag_add_plain_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
358
359
360 /**
361  * Defines a simple JTAG callback that can allow conversions on data
362  * scanned in from an interface.
363  *
364  * This callback should only be used for conversion that cannot fail.
365  * For conversion types or checks that can fail, use the more complete
366  * variant: jtag_callback_t.
367  */
368 typedef void (*jtag_callback1_t)(u8 *in);
369
370 /// A simpler version of jtag_add_callback4().
371 extern void jtag_add_callback(jtag_callback1_t, u8 *in);
372
373
374 /**
375  * Defines the type of data passed to the jtag_callback_t interface.
376  * The underlying type must allow storing an @c int or pointer type.
377  */
378 typedef intptr_t jtag_callback_data_t;
379
380 /**
381  * Defines the interface of the JTAG callback mechanism.
382  *
383  * @param in the pointer to the data clocked in
384  * @param data1 An integer big enough to use as an @c int or a pointer.
385  * @param data2 An integer big enough to use as an @c int or a pointer.
386  * @param data3 An integer big enough to use as an @c int or a pointer.
387  * @returns an error code
388  */
389 typedef int (*jtag_callback_t)(u8 *in, jtag_callback_data_t data1, jtag_callback_data_t data2, jtag_callback_data_t data3);
390
391
392 /**
393  * This callback can be executed immediately the queue has been flushed.
394  *
395  * The JTAG queue can be executed synchronously or asynchronously.
396  * Typically for USB, the queue is executed asynchronously.  For
397  * low-latency interfaces, the queue may be executed synchronously.
398  *
399  * The callback mechanism is very general and does not make many
400  * assumptions about what the callback does or what its arguments are.
401  * These callbacks are typically executed *after* the *entire* JTAG
402  * queue has been executed for e.g. USB interfaces, and they are
403  * guaranteeed to be invoked in the order that they were queued.
404  *
405  * If the execution of the queue fails before the callbacks, then --
406  * depending on driver implementation -- the callbacks may or may not be
407  * invoked.  @todo Can we make this behavior consistent?
408  *
409  * The strange name is due to C's lack of overloading using function
410  * arguments.
411  *
412  * @param f The callback function to add.
413  * @param in Typically used to point to the data to operate on.
414  * Frequently this will be the data clocked in during a shift operation.
415  * @param data1 An integer big enough to use as an @c int or a pointer.
416  * @param data2 An integer big enough to use as an @c int or a pointer.
417  * @param data3 An integer big enough to use as an @c int or a pointer.
418  *
419  */
420 extern void jtag_add_callback4(jtag_callback_t f, u8 *in,
421                 jtag_callback_data_t data1, jtag_callback_data_t data2,
422                 jtag_callback_data_t data3);
423
424
425 /**
426  * Run a TAP_RESET reset where the end state is TAP_RESET,
427  * regardless of the start state.
428  */
429 extern void jtag_add_tlr(void);
430
431 /**
432  * Application code *must* assume that interfaces will
433  * implement transitions between states with different
434  * paths and path lengths through the state diagram. The
435  * path will vary across interface and also across versions
436  * of the same interface over time. Even if the OpenOCD code
437  * is unchanged, the actual path taken may vary over time
438  * and versions of interface firmware or PCB revisions.
439  *
440  * Use jtag_add_pathmove() when specific transition sequences
441  * are required.
442  *
443  * Do not use jtag_add_pathmove() unless you need to, but do use it
444  * if you have to.
445  *
446  * DANGER! If the target is dependent upon a particular sequence
447  * of transitions for things to work correctly(e.g. as a workaround
448  * for an errata that contradicts the JTAG standard), then pathmove
449  * must be used, even if some jtag interfaces happen to use the
450  * desired path. Worse, the jtag interface used for testing a
451  * particular implementation, could happen to use the "desired"
452  * path when transitioning to/from end
453  * state.
454  *
455  * A list of unambigious single clock state transitions, not
456  * all drivers can support this, but it is required for e.g.
457  * XScale and Xilinx support
458  *
459  * Note! TAP_RESET must not be used in the path!
460  *
461  * Note that the first on the list must be reachable
462  * via a single transition from the current state.
463  *
464  * All drivers are required to implement jtag_add_pathmove().
465  * However, if the pathmove sequence can not be precisely
466  * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
467  * must return an error. It is legal, but not recommended, that
468  * a driver returns an error in all cases for a pathmove if it
469  * can only implement a few transitions and therefore
470  * a partial implementation of pathmove would have little practical
471  * application.
472  *
473  * If an error occurs, jtag_error will contain one of these error codes:
474  *   - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
475  *   - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
476  *   - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
477  *     state transitions.
478  */
479 extern void jtag_add_pathmove(int num_states, const tap_state_t* path);
480
481 /**
482  * Goes to TAP_IDLE (if we're not already there), cycle
483  * precisely num_cycles in the TAP_IDLE state, after which move
484  * to @a endstate (unless it is also TAP_IDLE).
485  *
486  * @param num_cycles Number of cycles in TAP_IDLE state.  This argument
487  *      may be 0, in which case this routine will navigate to @a endstate
488  *      via TAP_IDLE.
489  * @param endstate The final state.
490  */
491 extern void jtag_add_runtest(int num_cycles, tap_state_t endstate);
492
493 /**
494  * A reset of the TAP state machine can be requested.
495  *
496  * Whether tms or trst reset is used depends on the capabilities of
497  * the target and jtag interface(reset_config  command configures this).
498  *
499  * srst can driver a reset of the TAP state machine and vice
500  * versa
501  *
502  * Application code may need to examine value of jtag_reset_config
503  * to determine the proper codepath
504  *
505  * DANGER! Even though srst drives trst, trst might not be connected to
506  * the interface, and it might actually be *harmful* to assert trst in this case.
507  *
508  * This is why combinations such as "reset_config srst_only srst_pulls_trst"
509  * are supported.
510  *
511  * only req_tlr_or_trst and srst can have a transition for a
512  * call as the effects of transitioning both at the "same time"
513  * are undefined, but when srst_pulls_trst or vice versa,
514  * then trst & srst *must* be asserted together.
515  */
516 extern void jtag_add_reset(int req_tlr_or_trst, int srst);
517
518
519 /**
520  * Function jtag_set_end_state
521  *
522  * Set a global variable to \a state if \a state != TAP_INVALID.
523  *
524  * Return the value of the global variable.
525  *
526  **/
527 extern tap_state_t jtag_set_end_state(tap_state_t state);
528 /**
529  * Function jtag_get_end_state
530  *
531  * Return the value of the global variable for end state
532  *
533  **/
534 extern tap_state_t jtag_get_end_state(void);
535 extern void jtag_add_sleep(u32 us);
536
537
538 /**
539  * Function jtag_add_stable_clocks
540  * first checks that the state in which the clocks are to be issued is
541  * stable, then queues up clock_count clocks for transmission.
542  */
543 void jtag_add_clocks(int num_cycles);
544
545
546 /**
547  * For software FIFO implementations, the queued commands can be executed
548  * during this call or earlier. A sw queue might decide to push out
549  * some of the jtag_add_xxx() operations once the queue is "big enough".
550  *
551  * This fn will return an error code if any of the prior jtag_add_xxx()
552  * calls caused a failure, e.g. check failure. Note that it does not
553  * matter if the operation was executed *before* jtag_execute_queue(),
554  * jtag_execute_queue() will still return an error code.
555  *
556  * All jtag_add_xxx() calls that have in_handler!=NULL will have been
557  * executed when this fn returns, but if what has been queued only
558  * clocks data out, without reading anything back, then JTAG could
559  * be running *after* jtag_execute_queue() returns. The API does
560  * not define a way to flush a hw FIFO that runs *after*
561  * jtag_execute_queue() returns.
562  *
563  * jtag_add_xxx() commands can either be executed immediately or
564  * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
565  */
566 extern int jtag_execute_queue(void);
567
568 /* same as jtag_execute_queue() but does not clear the error flag */
569 extern void jtag_execute_queue_noclear(void);
570
571 /**
572  * The jtag_error variable is set when an error occurs while executing
573  * the queue.
574  *
575  * This flag can also be set from application code, if an error happens
576  * during processing that should be reported during jtag_execute_queue().
577  *
578  * It is cleared by jtag_execute_queue().
579  */
580 extern int jtag_error;
581
582 static __inline__ void jtag_set_error(int error)
583 {
584         if ((error==ERROR_OK)||(jtag_error!=ERROR_OK))
585         {
586                 /* keep first error */
587                 return;
588         }
589         jtag_error=error;
590 }
591
592 /**
593  * Resets jtag_error to ERROR_OK, returning its previous value.
594  * @returns The previous value of @c jtag_error.
595  */
596 static inline int jtag_error_clear(void)
597 {
598         int temp = jtag_error;
599         jtag_error = ERROR_OK;
600         return temp;
601 }
602
603 /* can be implemented by hw+sw */
604 extern int jtag_power_dropout(int* dropout);
605 extern int jtag_srst_asserted(int* srst_asserted);
606
607 /* JTAG support functions */
608
609 /**
610  * Execute jtag queue and check value with an optional mask.
611  * @param field Pointer to scan field.
612  * @param value Pointer to scan value.
613  * @param mask Pointer to scan mask; may be NULL.
614  * @returns Nothing, but calls jtag_set_error() on any error.
615  */
616 extern void jtag_check_value_mask(scan_field_t *field, u8 *value, u8 *mask);
617
618 extern void jtag_sleep(u32 us);
619 extern int jtag_call_event_callbacks(enum jtag_event event);
620 extern int jtag_register_event_callback(int (* callback)(enum jtag_event event, void* priv), void* priv);
621
622 extern int jtag_verify_capture_ir;
623
624 void jtag_tap_handle_event(jtag_tap_t* tap, enum jtag_tap_event e);
625
626 /*
627  * The JTAG subsystem defines a number of error codes,
628  * using codes between -100 and -199.
629  */
630 #define ERROR_JTAG_INIT_FAILED       (-100)
631 #define ERROR_JTAG_INVALID_INTERFACE (-101)
632 #define ERROR_JTAG_NOT_IMPLEMENTED   (-102)
633 #define ERROR_JTAG_TRST_ASSERTED     (-103)
634 #define ERROR_JTAG_QUEUE_FAILED      (-104)
635 #define ERROR_JTAG_NOT_STABLE_STATE  (-105)
636 #define ERROR_JTAG_DEVICE_ERROR      (-107)
637 #define ERROR_JTAG_STATE_INVALID     (-108)
638 #define ERROR_JTAG_TRANSITION_INVALID (-109)
639
640 /**
641  * jtag_add_dr_out() is a version of jtag_add_dr_scan() which
642  * only scans data out. It operates on 32 bit integers instead
643  * of 8 bit, which makes it a better impedance match with
644  * the calling code which often operate on 32 bit integers.
645  *
646  * Current or end_state can not be TAP_RESET. end_state can be TAP_INVALID
647  *
648  * num_bits[i] is the number of bits to clock out from value[i] LSB first.
649  *
650  * If the device is in bypass, then that is an error condition in
651  * the caller code that is not detected by this fn, whereas
652  * jtag_add_dr_scan() does detect it. Similarly if the device is not in
653  * bypass, data must be passed to it.
654  *
655  * If anything fails, then jtag_error will be set and jtag_execute() will
656  * return an error. There is no way to determine if there was a failure
657  * during this function call.
658  *
659  * This is an inline fn to speed up embedded hosts. Also note that
660  * interface_jtag_add_dr_out() can be a *small* inline function for
661  * embedded hosts.
662  *
663  * There is no jtag_add_dr_outin() version of this fn that also allows
664  * clocking data back in. Patches gladly accepted!
665  */
666 extern void jtag_add_dr_out(jtag_tap_t* tap,
667                 int num_fields, const int* num_bits, const u32* value,
668                 tap_state_t end_state);
669
670
671 /**
672  * jtag_add_statemove() moves from the current state to @a goal_state.
673  *
674  * @param goal_state The final TAP state.
675  * @return ERROR_OK on success, or an error code on failure.
676  *
677  * Moves from the current state to the goal \a state. 
678  *
679  * This needs to be handled according to the xsvf spec, see the XSTATE
680  * command description.  From the XSVF spec, pertaining to XSTATE:
681  *
682  * For special states known as stable states (Test-Logic-Reset,
683  * Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
684  * predefined TAP state paths when the starting state is a stable state
685  * and when the XSTATE specifies a new stable state.  See the STATE
686  * command in the [Ref 5] for the TAP state paths between stable
687  * states.
688  *
689  * For non-stable states, XSTATE should specify a state that is only one
690  * TAP state transition distance from the current TAP state to avoid
691  * undefined TAP state paths. A sequence of multiple XSTATE commands can
692  * be issued to transition the TAP through a specific state path.
693  *
694  * @note Unless @c tms_bits holds a path that agrees with [Ref 5] in the
695  * above spec, then this code is not fully conformant to the xsvf spec.
696  * This puts a burden on tap_get_tms_path() function from the xsvf spec.
697  * If in doubt, you should confirm that that burden is being met.
698  *
699  * Otherwise, @a goal_state must be immediately reachable in one clock
700  * cycle, and does not need to be a stable state.
701  */
702 extern int jtag_add_statemove(tap_state_t goal_state);
703
704 /// @returns the number of times the scan queue has been flushed
705 int jtag_get_flush_queue_count(void);
706
707 void jtag_set_nsrst_delay(unsigned delay);
708 unsigned jtag_get_nsrst_delay(void);
709
710 void jtag_set_ntrst_delay(unsigned delay);
711 unsigned jtag_get_ntrst_delay(void);
712
713 void jtag_set_speed_khz(unsigned speed);
714 unsigned jtag_get_speed_khz(void);
715
716 void jtag_set_verify(bool enable);
717 bool jtag_will_verify(void);
718
719 #endif /* JTAG_H */