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