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