jtag: make caller always allocate buffer
[fw/openocd] / src / jtag / jtag.h
1 /***************************************************************************
2 *   Copyright (C) 2005 by Dominic Rath                                    *
3 *   Dominic.Rath@gmx.de                                                   *
4 *                                                                         *
5 *   Copyright (C) 2007-2010 Ã˜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 <helper/binarybuffer.h>
27 #include <helper/log.h>
28
29 #ifdef _DEBUG_JTAG_IO_
30 #define DEBUG_JTAG_IO(expr ...) \
31         do { if (1) LOG_DEBUG(expr); } while (0)
32 #else
33 #define DEBUG_JTAG_IO(expr ...) \
34         do { if (0) LOG_DEBUG(expr); } while (0)
35 #endif
36
37 #ifndef DEBUG_JTAG_IOZ
38 #define DEBUG_JTAG_IOZ 64
39 #endif
40
41 /*-----</Macros>-------------------------------------------------*/
42
43 /**
44  * Defines JTAG Test Access Port states.
45  *
46  * These definitions were gleaned from the ARM7TDMI-S Technical
47  * Reference Manual and validated against several other ARM core
48  * technical manuals.
49  *
50  * FIXME some interfaces require specific numbers be used, as they
51  * are handed-off directly to their hardware implementations.
52  * Fix those drivers to map as appropriate ... then pick some
53  * sane set of numbers here (where 0/uninitialized == INVALID).
54  */
55 typedef enum tap_state
56 {
57         TAP_INVALID = -1,
58
59 #if BUILD_ZY1000
60         /* These are the old numbers. Leave as-is for now... */
61         TAP_RESET    = 0, TAP_IDLE = 8,
62         TAP_DRSELECT = 1, TAP_DRCAPTURE = 2, TAP_DRSHIFT = 3, TAP_DREXIT1 = 4,
63         TAP_DRPAUSE  = 5, TAP_DREXIT2 = 6, TAP_DRUPDATE = 7,
64         TAP_IRSELECT = 9, TAP_IRCAPTURE = 10, TAP_IRSHIFT = 11, TAP_IREXIT1 = 12,
65         TAP_IRPAUSE  = 13, TAP_IREXIT2 = 14, TAP_IRUPDATE = 15,
66
67 #else
68         /* Proper ARM recommended numbers */
69         TAP_DREXIT2 = 0x0,
70         TAP_DREXIT1 = 0x1,
71         TAP_DRSHIFT = 0x2,
72         TAP_DRPAUSE = 0x3,
73         TAP_IRSELECT = 0x4,
74         TAP_DRUPDATE = 0x5,
75         TAP_DRCAPTURE = 0x6,
76         TAP_DRSELECT = 0x7,
77         TAP_IREXIT2 = 0x8,
78         TAP_IREXIT1 = 0x9,
79         TAP_IRSHIFT = 0xa,
80         TAP_IRPAUSE = 0xb,
81         TAP_IDLE = 0xc,
82         TAP_IRUPDATE = 0xd,
83         TAP_IRCAPTURE = 0xe,
84         TAP_RESET = 0x0f,
85
86 #endif
87 } tap_state_t;
88
89 /**
90  * Function tap_state_name
91  * Returns a string suitable for display representing the JTAG tap_state
92  */
93 const char *tap_state_name(tap_state_t state);
94
95 /// Provides user-friendly name lookup of TAP states.
96 tap_state_t tap_state_by_name(const char *name);
97
98 /// The current TAP state of the pending JTAG command queue.
99 extern tap_state_t cmd_queue_cur_state;
100
101 /**
102  * This structure defines a single scan field in the scan. It provides
103  * fields for the field's width and pointers to scan input and output
104  * values.
105  *
106  * In addition, this structure includes a value and mask that is used by
107  * jtag_add_dr_scan_check() to validate the value that was scanned out.
108  */
109 struct scan_field {
110         /// The number of bits this field specifies (up to 32)
111         int num_bits;
112         /// A pointer to value to be scanned into the device
113         const uint8_t* out_value;
114         /// A pointer to a 32-bit memory location for data scanned out
115         uint8_t* in_value;
116
117         /// The value used to check the data scanned out.
118         uint8_t* check_value;
119         /// The mask to go with check_value
120         uint8_t* check_mask;
121 };
122
123 struct jtag_tap {
124         const char* chip;
125         const char* tapname;
126         const char* dotted_name;
127         int abs_chain_position;
128         /// Is this TAP disabled after JTAG reset?
129         bool disabled_after_reset;
130         /// Is this TAP currently enabled?
131         bool enabled;
132         int ir_length; /**< size of instruction register */
133         uint32_t ir_capture_value;
134         uint8_t* expected; /**< Capture-IR expected value */
135         uint32_t ir_capture_mask;
136         uint8_t* expected_mask; /**< Capture-IR expected mask */
137         uint32_t idcode; /**< device identification code */
138         /** not all devices have idcode,
139          * we'll discover this during chain examination */
140         bool hasidcode;
141
142         /// Array of expected identification codes */
143         uint32_t* expected_ids;
144         /// Number of expected identification codes
145         uint8_t expected_ids_cnt;
146
147         /// Flag saying whether to ignore version field in expected_ids[]
148         bool ignore_version;
149
150         /// current instruction
151         uint8_t* cur_instr;
152         /// Bypass register selected
153         int bypass;
154
155         struct jtag_tap_event_action *event_action;
156
157         struct jtag_tap* next_tap;
158         /* dap instance if some null if no instance , initialized to 0 by calloc*/
159         struct adiv5_dap *dap; 
160 };
161
162 void jtag_tap_init(struct jtag_tap *tap);
163 void jtag_tap_free(struct jtag_tap *tap);
164
165 struct jtag_tap* jtag_all_taps(void);
166 const char *jtag_tap_name(const struct jtag_tap *tap);
167 struct jtag_tap* jtag_tap_by_string(const char* dotted_name);
168 struct jtag_tap* jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj* obj);
169 struct jtag_tap* jtag_tap_by_position(unsigned abs_position);
170 struct jtag_tap* jtag_tap_next_enabled(struct jtag_tap* p);
171 unsigned jtag_tap_count_enabled(void);
172 unsigned jtag_tap_count(void);
173
174
175 /*
176  * - TRST_ASSERTED triggers two sets of callbacks, after operations to
177  *   reset the scan chain -- via TMS+TCK signaling, or deasserting the
178  *   nTRST signal -- are queued:
179  *
180  *    + Callbacks in C code fire first, patching internal state
181  *    + Then post-reset event scripts fire ... activating JTAG circuits
182  *      via TCK cycles, exiting SWD mode via TMS sequences, etc
183  *
184  *   During those callbacks, scan chain contents have not been validated.
185  *   JTAG operations that address a specific TAP (primarily DR/IR scans)
186  *   must *not* be queued.
187  *
188  * - TAP_EVENT_SETUP is reported after TRST_ASSERTED, and after the scan
189  *   chain has been validated.  JTAG operations including scans that
190  *   target specific TAPs may be performed.
191  *
192  * - TAP_EVENT_ENABLE and TAP_EVENT_DISABLE implement TAP activation and
193  *   deactivation outside the core using scripted code that understands
194  *   the specific JTAG router type.  They might be triggered indirectly
195  *   from EVENT_SETUP operations.
196  */
197 enum jtag_event {
198         JTAG_TRST_ASSERTED,
199         JTAG_TAP_EVENT_SETUP,
200         JTAG_TAP_EVENT_ENABLE,
201         JTAG_TAP_EVENT_DISABLE,
202 };
203
204 struct jtag_tap_event_action
205 {
206         /// The event for which this action will be triggered.
207         enum jtag_event event;
208         /// The interpreter to use for evaluating the @c body.
209         Jim_Interp *interp;
210         /// Contains a script to 'eval' when the @c event is triggered.
211         Jim_Obj *body;
212         // next action in linked list
213         struct jtag_tap_event_action *next;
214 };
215
216 /**
217  * Defines the function signature requide for JTAG event callback
218  * functions, which are added with jtag_register_event_callback()
219  * and removed jtag_unregister_event_callback().
220  * @param event The event to handle.
221  * @param prive A pointer to data that was passed to
222  *      jtag_register_event_callback().
223  * @returns Must return ERROR_OK on success, or an error code on failure.
224  *
225  * @todo Change to return void or define a use for its return code.
226  */
227 typedef int (*jtag_event_handler_t)(enum jtag_event event, void* priv);
228
229 int jtag_register_event_callback(jtag_event_handler_t f, void *x);
230 int jtag_unregister_event_callback(jtag_event_handler_t f, void *x);
231
232 int jtag_call_event_callbacks(enum jtag_event event);
233
234
235 /// @returns The current JTAG speed setting.
236 int jtag_get_speed(int *speed);
237
238 /**
239  * Given a @a speed setting, use the interface @c speed_div callback to
240  * adjust the setting.
241  * @param speed The speed setting to convert back to readable KHz.
242  * @returns ERROR_OK if the interface has not been initialized or on success;
243  *      otherwise, the error code produced by the @c speed_div callback.
244  */
245 int jtag_get_speed_readable(int *speed);
246
247 /// Attempt to configure the interface for the specified KHz.
248 int jtag_config_khz(unsigned khz);
249
250 /**
251  * Attempt to enable RTCK/RCLK. If that fails, fallback to the
252  * specified frequency.
253  */
254 int jtag_config_rclk(unsigned fallback_speed_khz);
255
256 /// Retreives the clock speed of the JTAG interface in KHz.
257 unsigned jtag_get_speed_khz(void);
258
259
260 enum reset_types {
261         RESET_NONE            = 0x0,
262         RESET_HAS_TRST        = 0x1,
263         RESET_HAS_SRST        = 0x2,
264         RESET_TRST_AND_SRST   = 0x3,
265         RESET_SRST_PULLS_TRST = 0x4,
266         RESET_TRST_PULLS_SRST = 0x8,
267         RESET_TRST_OPEN_DRAIN = 0x10,
268         RESET_SRST_PUSH_PULL  = 0x20,
269         RESET_SRST_NO_GATING  = 0x40,
270 };
271
272 enum reset_types jtag_get_reset_config(void);
273 void jtag_set_reset_config(enum reset_types type);
274
275 void jtag_set_nsrst_delay(unsigned delay);
276 unsigned jtag_get_nsrst_delay(void);
277
278 void jtag_set_ntrst_delay(unsigned delay);
279 unsigned jtag_get_ntrst_delay(void);
280
281 void jtag_set_nsrst_assert_width(unsigned delay);
282 unsigned jtag_get_nsrst_assert_width(void);
283
284 void jtag_set_ntrst_assert_width(unsigned delay);
285 unsigned jtag_get_ntrst_assert_width(void);
286
287 /// @returns The current state of TRST.
288 int jtag_get_trst(void);
289 /// @returns The current state of SRST.
290 int jtag_get_srst(void);
291
292 /// Enable or disable data scan verification checking.
293 void jtag_set_verify(bool enable);
294 /// @returns True if data scan verification will be performed.
295 bool jtag_will_verify(void);
296
297 /// Enable or disable verification of IR scan checking.
298 void jtag_set_verify_capture_ir(bool enable);
299 /// @returns True if IR scan verification will be performed.
300 bool jtag_will_verify_capture_ir(void);
301
302 /** Initialize debug adapter upon startup.  */
303 int  adapter_init(struct command_context* cmd_ctx);
304
305 /// Shutdown the debug adapter upon program exit.
306 int  adapter_quit(void);
307
308 /// Set ms to sleep after jtag_execute_queue() flushes queue. Debug
309 /// purposes.
310 void jtag_set_flush_queue_sleep(int ms);
311
312 /**
313  * Initialize JTAG chain using only a RESET reset. If init fails,
314  * try reset + init.
315  */
316 int  jtag_init(struct command_context* cmd_ctx);
317
318 /// reset, then initialize JTAG chain
319 int jtag_init_reset(struct command_context* cmd_ctx);
320 int jtag_register_commands(struct command_context* cmd_ctx);
321 int jtag_init_inner(struct command_context *cmd_ctx);
322
323 /**
324  * @file
325  * The JTAG interface can be implemented with a software or hardware fifo.
326  *
327  * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states; however,
328  * TAP_DRSHIFT/IRSHIFT can be emulated as end states, by using longer
329  * scans.
330  *
331  * Code that is relatively insensitive to the path taken through state
332  * machine (as long as it is JTAG compliant) can use @a endstate for
333  * jtag_add_xxx_scan(). Otherwise, the pause state must be specified as
334  * end state and a subsequent jtag_add_pathmove() must be issued.
335  */
336
337 /**
338  * Generate an IR SCAN with a list of scan fields with one entry for
339  * each enabled TAP.
340  *
341  * If the input field list contains an instruction value for a TAP then
342  * that is used otherwise the TAP is set to bypass.
343  *
344  * TAPs for which no fields are passed are marked as bypassed for
345  * subsequent DR SCANs.
346  *
347  */
348 void jtag_add_ir_scan(struct jtag_tap* tap,
349                 struct scan_field* fields, tap_state_t endstate);
350 /**
351  * The same as jtag_add_ir_scan except no verification is performed out
352  * the output values.
353  */
354 void jtag_add_ir_scan_noverify(struct jtag_tap* tap,
355                 const struct scan_field *fields, tap_state_t state);
356 /**
357  * Scan out the bits in ir scan mode.
358  *
359  * If in_bits == NULL, discard incoming bits.
360  */
361 void jtag_add_plain_ir_scan(int num_bits, const uint8_t *out_bits, uint8_t *in_bits,
362                 tap_state_t endstate);
363
364
365 /**
366  * Generate a DR SCAN using the fields passed to the function.
367  * For connected TAPs, the function checks in_fields and uses fields
368  * specified there.  For bypassed TAPs, the function generates a dummy
369  * 1-bit field.  The bypass status of TAPs is set by jtag_add_ir_scan().
370  */
371 void jtag_add_dr_scan(struct jtag_tap* tap, int num_fields,
372                 const struct scan_field* fields, tap_state_t endstate);
373 /// A version of jtag_add_dr_scan() that uses the check_value/mask fields
374 void jtag_add_dr_scan_check(struct jtag_tap* tap, int num_fields,
375                 struct scan_field* fields, tap_state_t endstate);
376 /**
377  * Scan out the bits in ir scan mode.
378  *
379  * If in_bits == NULL, discard incoming bits.
380  */
381 void jtag_add_plain_dr_scan(int num_bits,
382                 const uint8_t *out_bits, uint8_t *in_bits, tap_state_t endstate);
383
384 /**
385  * Defines the type of data passed to the jtag_callback_t interface.
386  * The underlying type must allow storing an @c int or pointer type.
387  */
388 typedef intptr_t jtag_callback_data_t;
389
390 /**
391  * Defines a simple JTAG callback that can allow conversions on data
392  * scanned in from an interface.
393  *
394  * This callback should only be used for conversion that cannot fail.
395  * For conversion types or checks that can fail, use the more complete
396  * variant: jtag_callback_t.
397  */
398 typedef void (*jtag_callback1_t)(jtag_callback_data_t data0);
399
400 /// A simpler version of jtag_add_callback4().
401 void jtag_add_callback(jtag_callback1_t, jtag_callback_data_t data0);
402
403
404 /**
405  * Defines the interface of the JTAG callback mechanism.  Such
406  * callbacks can be executed once the queue has been flushed.
407  *
408  * The JTAG queue can be executed synchronously or asynchronously.
409  * Typically for USB, the queue is executed asynchronously.  For
410  * low-latency interfaces, the queue may be executed synchronously.
411  *
412  * The callback mechanism is very general and does not make many
413  * assumptions about what the callback does or what its arguments are.
414  * These callbacks are typically executed *after* the *entire* JTAG
415  * queue has been executed for e.g. USB interfaces, and they are
416  * guaranteeed to be invoked in the order that they were queued.
417  *
418  * If the execution of the queue fails before the callbacks, then --
419  * depending on driver implementation -- the callbacks may or may not be
420  * invoked.
421  *
422  * @todo Make that behavior consistent.
423  *
424  * @param data0 Typically used to point to the data to operate on.
425  * Frequently this will be the data clocked in during a shift operation.
426  * @param data1 An integer big enough to use as an @c int or a pointer.
427  * @param data2 An integer big enough to use as an @c int or a pointer.
428  * @param data3 An integer big enough to use as an @c int or a pointer.
429  * @returns an error code
430  */
431 typedef int (*jtag_callback_t)(jtag_callback_data_t data0,
432                                 jtag_callback_data_t data1,
433                                 jtag_callback_data_t data2,
434                                 jtag_callback_data_t data3);
435
436 /**
437  * Run a TAP_RESET reset where the end state is TAP_RESET,
438  * regardless of the start state.
439  */
440 void jtag_add_tlr(void);
441
442 /**
443  * Application code *must* assume that interfaces will
444  * implement transitions between states with different
445  * paths and path lengths through the state diagram. The
446  * path will vary across interface and also across versions
447  * of the same interface over time. Even if the OpenOCD code
448  * is unchanged, the actual path taken may vary over time
449  * and versions of interface firmware or PCB revisions.
450  *
451  * Use jtag_add_pathmove() when specific transition sequences
452  * are required.
453  *
454  * Do not use jtag_add_pathmove() unless you need to, but do use it
455  * if you have to.
456  *
457  * DANGER! If the target is dependent upon a particular sequence
458  * of transitions for things to work correctly(e.g. as a workaround
459  * for an errata that contradicts the JTAG standard), then pathmove
460  * must be used, even if some jtag interfaces happen to use the
461  * desired path. Worse, the jtag interface used for testing a
462  * particular implementation, could happen to use the "desired"
463  * path when transitioning to/from end
464  * state.
465  *
466  * A list of unambigious single clock state transitions, not
467  * all drivers can support this, but it is required for e.g.
468  * XScale and Xilinx support
469  *
470  * Note! TAP_RESET must not be used in the path!
471  *
472  * Note that the first on the list must be reachable
473  * via a single transition from the current state.
474  *
475  * All drivers are required to implement jtag_add_pathmove().
476  * However, if the pathmove sequence can not be precisely
477  * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
478  * must return an error. It is legal, but not recommended, that
479  * a driver returns an error in all cases for a pathmove if it
480  * can only implement a few transitions and therefore
481  * a partial implementation of pathmove would have little practical
482  * application.
483  *
484  * If an error occurs, jtag_error will contain one of these error codes:
485  *   - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
486  *   - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
487  *   - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
488  *     state transitions.
489  */
490 void jtag_add_pathmove(int num_states, const tap_state_t* path);
491
492 /**
493  * jtag_add_statemove() moves from the current state to @a goal_state.
494  *
495  * @param goal_state The final TAP state.
496  * @return ERROR_OK on success, or an error code on failure.
497  *
498  * Moves from the current state to the goal \a state.
499  * Both states must be stable.
500  */
501 int jtag_add_statemove(tap_state_t goal_state);
502
503 /**
504  * Goes to TAP_IDLE (if we're not already there), cycle
505  * precisely num_cycles in the TAP_IDLE state, after which move
506  * to @a endstate (unless it is also TAP_IDLE).
507  *
508  * @param num_cycles Number of cycles in TAP_IDLE state.  This argument
509  *      may be 0, in which case this routine will navigate to @a endstate
510  *      via TAP_IDLE.
511  * @param endstate The final state.
512  */
513 void jtag_add_runtest(int num_cycles, tap_state_t endstate);
514
515 /**
516  * A reset of the TAP state machine can be requested.
517  *
518  * Whether tms or trst reset is used depends on the capabilities of
519  * the target and jtag interface(reset_config  command configures this).
520  *
521  * srst can driver a reset of the TAP state machine and vice
522  * versa
523  *
524  * Application code may need to examine value of jtag_reset_config
525  * to determine the proper codepath
526  *
527  * DANGER! Even though srst drives trst, trst might not be connected to
528  * the interface, and it might actually be *harmful* to assert trst in this case.
529  *
530  * This is why combinations such as "reset_config srst_only srst_pulls_trst"
531  * are supported.
532  *
533  * only req_tlr_or_trst and srst can have a transition for a
534  * call as the effects of transitioning both at the "same time"
535  * are undefined, but when srst_pulls_trst or vice versa,
536  * then trst & srst *must* be asserted together.
537  */
538 void jtag_add_reset(int req_tlr_or_trst, int srst);
539
540 void jtag_add_sleep(uint32_t us);
541
542 int jtag_add_tms_seq(unsigned nbits, const uint8_t *seq, enum tap_state t);
543
544 /**
545  * Function jtag_add_clocks
546  * first checks that the state in which the clocks are to be issued is
547  * stable, then queues up num_cycles clocks for transmission.
548  */
549 void jtag_add_clocks(int num_cycles);
550
551
552 /**
553  * For software FIFO implementations, the queued commands can be executed
554  * during this call or earlier. A sw queue might decide to push out
555  * some of the jtag_add_xxx() operations once the queue is "big enough".
556  *
557  * This fn will return an error code if any of the prior jtag_add_xxx()
558  * calls caused a failure, e.g. check failure. Note that it does not
559  * matter if the operation was executed *before* jtag_execute_queue(),
560  * jtag_execute_queue() will still return an error code.
561  *
562  * All jtag_add_xxx() calls that have in_handler != NULL will have been
563  * executed when this fn returns, but if what has been queued only
564  * clocks data out, without reading anything back, then JTAG could
565  * be running *after* jtag_execute_queue() returns. The API does
566  * not define a way to flush a hw FIFO that runs *after*
567  * jtag_execute_queue() returns.
568  *
569  * jtag_add_xxx() commands can either be executed immediately or
570  * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
571  */
572 int jtag_execute_queue(void);
573
574 /// same as jtag_execute_queue() but does not clear the error flag
575 void jtag_execute_queue_noclear(void);
576
577 /// @returns the number of times the scan queue has been flushed
578 int jtag_get_flush_queue_count(void);
579
580 /// Report Tcl event to all TAPs
581 void jtag_notify_event(enum jtag_event);
582
583
584 /* can be implemented by hw + sw */
585 int jtag_power_dropout(int* dropout);
586 int jtag_srst_asserted(int* srst_asserted);
587
588 /* JTAG support functions */
589
590 /**
591  * Execute jtag queue and check value with an optional mask.
592  * @param field Pointer to scan field.
593  * @param value Pointer to scan value.
594  * @param mask Pointer to scan mask; may be NULL.
595  * @returns Nothing, but calls jtag_set_error() on any error.
596  */
597 void jtag_check_value_mask(struct scan_field *field, uint8_t *value, uint8_t *mask);
598
599 void jtag_sleep(uint32_t us);
600
601 /*
602  * The JTAG subsystem defines a number of error codes,
603  * using codes between -100 and -199.
604  */
605 #define ERROR_JTAG_INIT_FAILED       (-100)
606 #define ERROR_JTAG_INVALID_INTERFACE (-101)
607 #define ERROR_JTAG_NOT_IMPLEMENTED   (-102)
608 #define ERROR_JTAG_TRST_ASSERTED     (-103)
609 #define ERROR_JTAG_QUEUE_FAILED      (-104)
610 #define ERROR_JTAG_NOT_STABLE_STATE  (-105)
611 #define ERROR_JTAG_DEVICE_ERROR      (-107)
612 #define ERROR_JTAG_STATE_INVALID     (-108)
613 #define ERROR_JTAG_TRANSITION_INVALID (-109)
614 #define ERROR_JTAG_INIT_SOFT_FAIL    (-110)
615
616 /**
617  * jtag_add_dr_out() is a version of jtag_add_dr_scan() which
618  * only scans data out. It operates on 32 bit integers instead
619  * of 8 bit, which makes it a better impedance match with
620  * the calling code which often operate on 32 bit integers.
621  *
622  * Current or end_state can not be TAP_RESET. end_state can be TAP_INVALID
623  *
624  * num_bits[i] is the number of bits to clock out from value[i] LSB first.
625  *
626  * If the device is in bypass, then that is an error condition in
627  * the caller code that is not detected by this fn, whereas
628  * jtag_add_dr_scan() does detect it. Similarly if the device is not in
629  * bypass, data must be passed to it.
630  *
631  * If anything fails, then jtag_error will be set and jtag_execute() will
632  * return an error. There is no way to determine if there was a failure
633  * during this function call.
634  *
635  * This is an inline fn to speed up embedded hosts. Also note that
636  * interface_jtag_add_dr_out() can be a *small* inline function for
637  * embedded hosts.
638  *
639  * There is no jtag_add_dr_outin() version of this fn that also allows
640  * clocking data back in. Patches gladly accepted!
641  */
642
643
644 /**
645  * Set the current JTAG core execution error, unless one was set
646  * by a previous call previously.  Driver or application code must
647  * use jtag_error_clear to reset jtag_error once this routine has been
648  * called with a non-zero error code.
649  */
650 void jtag_set_error(int error);
651 /**
652  * Resets jtag_error to ERROR_OK, returning its previous value.
653  * @returns The previous value of @c jtag_error.
654  */
655 int jtag_error_clear(void);
656
657 /**
658  * Return true if it's safe for a background polling task to access the
659  * JTAG scan chain.  Polling may be explicitly disallowed, and is also
660  * unsafe while nTRST is active or the JTAG clock is gated off.
661  */
662 bool is_jtag_poll_safe(void);
663
664 /**
665  * Return flag reporting whether JTAG polling is disallowed.
666  */
667 bool jtag_poll_get_enabled(void);
668
669 /**
670  * Assign flag reporting whether JTAG polling is disallowed.
671  */
672 void jtag_poll_set_enabled(bool value);
673
674
675 /* The minidriver may have inline versions of some of the low
676  * level APIs that are used in inner loops. */
677 #include <jtag/minidriver.h>
678
679 bool transport_is_jtag(void);
680
681 int jim_jtag_newtap(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
682
683 #endif /* JTAG_H */