Introduced jtag_init and "jtag arp_init" to allow target scripts more control over...
[openocd.git] / src / jtag / jtag.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the *
20 * Free Software Foundation, Inc., *
21 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
22 ***************************************************************************/
23 #ifndef JTAG_H
24 #define JTAG_H
25
26 #include "binarybuffer.h"
27 #include "log.h"
28
29
30 #ifdef _DEBUG_JTAG_IO_
31 #define DEBUG_JTAG_IO(expr ...) LOG_DEBUG(expr)
32 #else
33 #define DEBUG_JTAG_IO(expr ...)
34 #endif
35
36 #ifndef DEBUG_JTAG_IOZ
37 #define DEBUG_JTAG_IOZ 64
38 #endif
39
40 /*-----<Macros>--------------------------------------------------*/
41
42 /**
43 * When given an array, compute its DIMension; in other words, the
44 * number of elements in the array
45 */
46 #define DIM(x) (sizeof(x)/sizeof((x)[0]))
47
48 /** Calculate the number of bytes required to hold @a n TAP scan bits */
49 #define TAP_SCAN_BYTES(n) CEIL(n, 8)
50
51 /*-----</Macros>-------------------------------------------------*/
52
53 /**
54 * Defines JTAG Test Access Port states.
55 *
56 * These definitions were gleaned from the ARM7TDMI-S Technical
57 * Reference Manual and validated against several other ARM core
58 * technical manuals. tap_get_tms_path() is sensitive to this numbering
59 * and ordering of the TAP states; furthermore, some interfaces require
60 * specific numbers be used, as they are handed-off directly to their
61 * hardware implementations.
62 */
63 typedef enum tap_state
64 {
65 #if BUILD_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 * - TRST_ASSERTED triggers two sets of callbacks, after operations to
196 * reset the scan chain -- via TMS+TCK signaling, or deasserting the
197 * nTRST signal -- are queued:
198 *
199 * + Callbacks in C code fire first, patching internal state
200 * + Then post-reset event scripts fire ... activating JTAG circuits
201 * via TCK cycles, exiting SWD mode via TMS sequences, etc
202 *
203 * During those callbacks, scan chain contents have not been validated.
204 * JTAG operations that address a specific TAP (primarily DR/IR scans)
205 * must *not* be queued.
206 *
207 * - TAP_EVENT_SETUP is reported after TRST_ASSERTED, and after the scan
208 * chain has been validated. JTAG operations including scans that
209 * target specific TAPs may be performed.
210 *
211 * - TAP_EVENT_ENABLE and TAP_EVENT_DISABLE implement TAP activation and
212 * deactivation outside the core using scripted code that understands
213 * the specific JTAG router type. They might be triggered indirectly
214 * from EVENT_SETUP operations.
215 */
216 enum jtag_event {
217 JTAG_TRST_ASSERTED,
218 JTAG_TAP_EVENT_SETUP,
219 JTAG_TAP_EVENT_ENABLE,
220 JTAG_TAP_EVENT_DISABLE,
221 };
222
223 struct jtag_tap_event_action_s
224 {
225 enum jtag_event event;
226 Jim_Obj* body;
227 jtag_tap_event_action_t* next;
228 };
229
230 /**
231 * Defines the function signature requide for JTAG event callback
232 * functions, which are added with jtag_register_event_callback()
233 * and removed jtag_unregister_event_callback().
234 * @param event The event to handle.
235 * @param prive A pointer to data that was passed to
236 * jtag_register_event_callback().
237 * @returns Must return ERROR_OK on success, or an error code on failure.
238 *
239 * @todo Change to return void or define a use for its return code.
240 */
241 typedef int (*jtag_event_handler_t)(enum jtag_event event, void* priv);
242
243 extern int jtag_register_event_callback(jtag_event_handler_t f, void *x);
244 extern int jtag_unregister_event_callback(jtag_event_handler_t f, void *x);
245
246 extern int jtag_call_event_callbacks(enum jtag_event event);
247
248
249 /// @returns The current JTAG speed setting.
250 int jtag_get_speed(void);
251 /**
252 * Given a @a speed setting, use the interface @c speed_div callback to
253 * adjust the setting.
254 * @param speed The speed setting to convert back to readable KHz.
255 * @returns ERROR_OK if the interface has not been initialized or on success;
256 * otherwise, the error code produced by the @c speed_div callback.
257 */
258 int jtag_get_speed_readable(int *speed);
259 /**
260 * Set the JTAG speed. This routine will call the underlying
261 * interface @c speed callback, if the interface has been initialized.
262 * @param speed The new speed setting.
263 * @returns ERROR_OK during configuration or on success, or an error
264 * code returned from the interface @c speed callback.
265 */
266 int jtag_config_speed(int speed);
267
268
269 /// Attempt to configure the interface for the specified KHz.
270 int jtag_config_khz(unsigned khz);
271 /**
272 * Attempt to enable RTCK/RCLK. If that fails, fallback to the
273 * specified frequency.
274 */
275 int jtag_config_rclk(unsigned fallback_speed_khz);
276 /// Retreives the clock speed of the JTAG interface in KHz.
277 unsigned jtag_get_speed_khz(void);
278
279
280 enum reset_types {
281 RESET_NONE = 0x0,
282 RESET_HAS_TRST = 0x1,
283 RESET_HAS_SRST = 0x2,
284 RESET_TRST_AND_SRST = 0x3,
285 RESET_SRST_PULLS_TRST = 0x4,
286 RESET_TRST_PULLS_SRST = 0x8,
287 RESET_TRST_OPEN_DRAIN = 0x10,
288 RESET_SRST_PUSH_PULL = 0x20,
289 RESET_SRST_GATES_JTAG = 0x40,
290 };
291
292 enum reset_types jtag_get_reset_config(void);
293 void jtag_set_reset_config(enum reset_types type);
294
295 void jtag_set_nsrst_delay(unsigned delay);
296 unsigned jtag_get_nsrst_delay(void);
297
298 void jtag_set_ntrst_delay(unsigned delay);
299 unsigned jtag_get_ntrst_delay(void);
300
301 void jtag_set_nsrst_assert_width(unsigned delay);
302 unsigned jtag_get_nsrst_assert_width(void);
303
304 void jtag_set_ntrst_assert_width(unsigned delay);
305 unsigned jtag_get_ntrst_assert_width(void);
306
307 /// @returns The current state of TRST.
308 int jtag_get_trst(void);
309 /// @returns The current state of SRST.
310 int jtag_get_srst(void);
311
312 /// Enable or disable data scan verification checking.
313 void jtag_set_verify(bool enable);
314 /// @returns True if data scan verification will be performed.
315 bool jtag_will_verify(void);
316
317 /// Enable or disable verification of IR scan checking.
318 void jtag_set_verify_capture_ir(bool enable);
319 /// @returns True if IR scan verification will be performed.
320 bool jtag_will_verify_capture_ir(void);
321
322 /**
323 * Initialize interface upon startup. Return a successful no-op upon
324 * subsequent invocations.
325 */
326 extern int jtag_interface_init(struct command_context_s* cmd_ctx);
327
328 /// Shutdown the JTAG interface upon program exit.
329 extern int jtag_interface_quit(void);
330
331 /**
332 * Initialize JTAG chain using only a RESET reset. If init fails,
333 * try reset + init.
334 */
335 extern int jtag_init(struct command_context_s* cmd_ctx);
336
337 /// reset, then initialize JTAG chain
338 extern int jtag_init_reset(struct command_context_s* cmd_ctx);
339 extern int jtag_register_commands(struct command_context_s* cmd_ctx);
340 extern int jtag_init_inner(struct command_context_s *cmd_ctx);
341
342 /**
343 * @file
344 * The JTAG interface can be implemented with a software or hardware fifo.
345 *
346 * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states; however,
347 * TAP_DRSHIFT/IRSHIFT can be emulated as end states, by using longer
348 * scans.
349 *
350 * Code that is relatively insensitive to the path taken through state
351 * machine (as long as it is JTAG compliant) can use @a endstate for
352 * jtag_add_xxx_scan(). Otherwise, the pause state must be specified as
353 * end state and a subsequent jtag_add_pathmove() must be issued.
354 */
355
356 /**
357 * Generate an IR SCAN with a list of scan fields with one entry for
358 * each enabled TAP.
359 *
360 * If the input field list contains an instruction value for a TAP then
361 * that is used otherwise the TAP is set to bypass.
362 *
363 * TAPs for which no fields are passed are marked as bypassed for
364 * subsequent DR SCANs.
365 *
366 */
367 extern void jtag_add_ir_scan(int num_fields, scan_field_t* fields, tap_state_t endstate);
368 /**
369 * The same as jtag_add_ir_scan except no verification is performed out
370 * the output values.
371 */
372 extern void jtag_add_ir_scan_noverify(int num_fields, const scan_field_t *fields, tap_state_t state);
373 /**
374 * Duplicate the scan fields passed into the function into an IR SCAN
375 * command. This function assumes that the caller handles extra fields
376 * for bypassed TAPs.
377 */
378 extern void jtag_add_plain_ir_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
379
380
381 /**
382 * Set in_value to point to 32 bits of memory to scan into. This
383 * function is a way to handle the case of synchronous and asynchronous
384 * JTAG queues.
385 *
386 * In the event of an asynchronous queue execution the queue buffer
387 * allocation method is used, for the synchronous case the temporary 32
388 * bits come from the input field itself.
389 */
390 extern void jtag_alloc_in_value32(scan_field_t *field);
391
392 /**
393 * Generate a DR SCAN using the fields passed to the function.
394 * For connected TAPs, the function checks in_fields and uses fields
395 * specified there. For bypassed TAPs, the function generates a dummy
396 * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
397 */
398 extern void jtag_add_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
399 /// A version of jtag_add_dr_scan() that uses the check_value/mask fields
400 extern void jtag_add_dr_scan_check(int num_fields, scan_field_t* fields, tap_state_t endstate);
401 /**
402 * Duplicate the scan fields passed into the function into a DR SCAN
403 * command. Unlike jtag_add_dr_scan(), this function assumes that the
404 * caller handles extra fields for bypassed TAPs.
405 */
406 extern void jtag_add_plain_dr_scan(int num_fields, const scan_field_t* fields, tap_state_t endstate);
407
408 /**
409 * Defines the type of data passed to the jtag_callback_t interface.
410 * The underlying type must allow storing an @c int or pointer type.
411 */
412 typedef intptr_t jtag_callback_data_t;
413
414 /**
415 * Defines a simple JTAG callback that can allow conversions on data
416 * scanned in from an interface.
417 *
418 * This callback should only be used for conversion that cannot fail.
419 * For conversion types or checks that can fail, use the more complete
420 * variant: jtag_callback_t.
421 */
422 typedef void (*jtag_callback1_t)(jtag_callback_data_t data0);
423
424 /// A simpler version of jtag_add_callback4().
425 extern void jtag_add_callback(jtag_callback1_t, jtag_callback_data_t data0);
426
427
428
429 /**
430 * Defines the interface of the JTAG callback mechanism.
431 *
432 * @param in the pointer to the data clocked in
433 * @param data1 An integer big enough to use as an @c int or a pointer.
434 * @param data2 An integer big enough to use as an @c int or a pointer.
435 * @param data3 An integer big enough to use as an @c int or a pointer.
436 * @returns an error code
437 */
438 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);
439
440
441 /**
442 * This callback can be executed immediately the queue has been flushed.
443 *
444 * The JTAG queue can be executed synchronously or asynchronously.
445 * Typically for USB, the queue is executed asynchronously. For
446 * low-latency interfaces, the queue may be executed synchronously.
447 *
448 * The callback mechanism is very general and does not make many
449 * assumptions about what the callback does or what its arguments are.
450 * These callbacks are typically executed *after* the *entire* JTAG
451 * queue has been executed for e.g. USB interfaces, and they are
452 * guaranteeed to be invoked in the order that they were queued.
453 *
454 * If the execution of the queue fails before the callbacks, then --
455 * depending on driver implementation -- the callbacks may or may not be
456 * invoked. @todo Can we make this behavior consistent?
457 *
458 * The strange name is due to C's lack of overloading using function
459 * arguments.
460 *
461 * @param f The callback function to add.
462 * @param data0 Typically used to point to the data to operate on.
463 * Frequently this will be the data clocked in during a shift operation.
464 * @param data1 An integer big enough to use as an @c int or a pointer.
465 * @param data2 An integer big enough to use as an @c int or a pointer.
466 * @param data3 An integer big enough to use as an @c int or a pointer.
467 *
468 */
469 extern void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0,
470 jtag_callback_data_t data1, jtag_callback_data_t data2,
471 jtag_callback_data_t data3);
472
473
474 /**
475 * Run a TAP_RESET reset where the end state is TAP_RESET,
476 * regardless of the start state.
477 */
478 extern void jtag_add_tlr(void);
479
480 /**
481 * Application code *must* assume that interfaces will
482 * implement transitions between states with different
483 * paths and path lengths through the state diagram. The
484 * path will vary across interface and also across versions
485 * of the same interface over time. Even if the OpenOCD code
486 * is unchanged, the actual path taken may vary over time
487 * and versions of interface firmware or PCB revisions.
488 *
489 * Use jtag_add_pathmove() when specific transition sequences
490 * are required.
491 *
492 * Do not use jtag_add_pathmove() unless you need to, but do use it
493 * if you have to.
494 *
495 * DANGER! If the target is dependent upon a particular sequence
496 * of transitions for things to work correctly(e.g. as a workaround
497 * for an errata that contradicts the JTAG standard), then pathmove
498 * must be used, even if some jtag interfaces happen to use the
499 * desired path. Worse, the jtag interface used for testing a
500 * particular implementation, could happen to use the "desired"
501 * path when transitioning to/from end
502 * state.
503 *
504 * A list of unambigious single clock state transitions, not
505 * all drivers can support this, but it is required for e.g.
506 * XScale and Xilinx support
507 *
508 * Note! TAP_RESET must not be used in the path!
509 *
510 * Note that the first on the list must be reachable
511 * via a single transition from the current state.
512 *
513 * All drivers are required to implement jtag_add_pathmove().
514 * However, if the pathmove sequence can not be precisely
515 * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
516 * must return an error. It is legal, but not recommended, that
517 * a driver returns an error in all cases for a pathmove if it
518 * can only implement a few transitions and therefore
519 * a partial implementation of pathmove would have little practical
520 * application.
521 *
522 * If an error occurs, jtag_error will contain one of these error codes:
523 * - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
524 * - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
525 * - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
526 * state transitions.
527 */
528 extern void jtag_add_pathmove(int num_states, const tap_state_t* path);
529
530 /**
531 * jtag_add_statemove() moves from the current state to @a goal_state.
532 *
533 * @param goal_state The final TAP state.
534 * @return ERROR_OK on success, or an error code on failure.
535 *
536 * Moves from the current state to the goal \a state.
537 *
538 * This needs to be handled according to the xsvf spec, see the XSTATE
539 * command description. From the XSVF spec, pertaining to XSTATE:
540 *
541 * For special states known as stable states (Test-Logic-Reset,
542 * Run-Test/Idle, Pause-DR, Pause- IR), an XSVF interpreter follows
543 * predefined TAP state paths when the starting state is a stable state
544 * and when the XSTATE specifies a new stable state. See the STATE
545 * command in the [Ref 5] for the TAP state paths between stable
546 * states.
547 *
548 * For non-stable states, XSTATE should specify a state that is only one
549 * TAP state transition distance from the current TAP state to avoid
550 * undefined TAP state paths. A sequence of multiple XSTATE commands can
551 * be issued to transition the TAP through a specific state path.
552 *
553 * @note Unless @c tms_bits holds a path that agrees with [Ref 5] in the
554 * above spec, then this code is not fully conformant to the xsvf spec.
555 * This puts a burden on tap_get_tms_path() function from the xsvf spec.
556 * If in doubt, you should confirm that that burden is being met.
557 *
558 * Otherwise, @a goal_state must be immediately reachable in one clock
559 * cycle, and does not need to be a stable state.
560 */
561 extern int jtag_add_statemove(tap_state_t goal_state);
562
563 /**
564 * Goes to TAP_IDLE (if we're not already there), cycle
565 * precisely num_cycles in the TAP_IDLE state, after which move
566 * to @a endstate (unless it is also TAP_IDLE).
567 *
568 * @param num_cycles Number of cycles in TAP_IDLE state. This argument
569 * may be 0, in which case this routine will navigate to @a endstate
570 * via TAP_IDLE.
571 * @param endstate The final state.
572 */
573 extern void jtag_add_runtest(int num_cycles, tap_state_t endstate);
574
575 /**
576 * A reset of the TAP state machine can be requested.
577 *
578 * Whether tms or trst reset is used depends on the capabilities of
579 * the target and jtag interface(reset_config command configures this).
580 *
581 * srst can driver a reset of the TAP state machine and vice
582 * versa
583 *
584 * Application code may need to examine value of jtag_reset_config
585 * to determine the proper codepath
586 *
587 * DANGER! Even though srst drives trst, trst might not be connected to
588 * the interface, and it might actually be *harmful* to assert trst in this case.
589 *
590 * This is why combinations such as "reset_config srst_only srst_pulls_trst"
591 * are supported.
592 *
593 * only req_tlr_or_trst and srst can have a transition for a
594 * call as the effects of transitioning both at the "same time"
595 * are undefined, but when srst_pulls_trst or vice versa,
596 * then trst & srst *must* be asserted together.
597 */
598 extern void jtag_add_reset(int req_tlr_or_trst, int srst);
599
600
601 /**
602 * Function jtag_set_end_state
603 *
604 * Set a global variable to \a state if \a state != TAP_INVALID.
605 *
606 * Return the value of the global variable.
607 *
608 **/
609 extern tap_state_t jtag_set_end_state(tap_state_t state);
610 /**
611 * Function jtag_get_end_state
612 *
613 * Return the value of the global variable for end state
614 *
615 **/
616 extern tap_state_t jtag_get_end_state(void);
617 extern void jtag_add_sleep(uint32_t us);
618
619
620 /**
621 * Function jtag_add_stable_clocks
622 * first checks that the state in which the clocks are to be issued is
623 * stable, then queues up clock_count clocks for transmission.
624 */
625 void jtag_add_clocks(int num_cycles);
626
627
628 /**
629 * For software FIFO implementations, the queued commands can be executed
630 * during this call or earlier. A sw queue might decide to push out
631 * some of the jtag_add_xxx() operations once the queue is "big enough".
632 *
633 * This fn will return an error code if any of the prior jtag_add_xxx()
634 * calls caused a failure, e.g. check failure. Note that it does not
635 * matter if the operation was executed *before* jtag_execute_queue(),
636 * jtag_execute_queue() will still return an error code.
637 *
638 * All jtag_add_xxx() calls that have in_handler != NULL will have been
639 * executed when this fn returns, but if what has been queued only
640 * clocks data out, without reading anything back, then JTAG could
641 * be running *after* jtag_execute_queue() returns. The API does
642 * not define a way to flush a hw FIFO that runs *after*
643 * jtag_execute_queue() returns.
644 *
645 * jtag_add_xxx() commands can either be executed immediately or
646 * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
647 */
648 extern int jtag_execute_queue(void);
649
650 /// same as jtag_execute_queue() but does not clear the error flag
651 extern void jtag_execute_queue_noclear(void);
652
653 /// @returns the number of times the scan queue has been flushed
654 int jtag_get_flush_queue_count(void);
655
656 /// Report Tcl event to all TAPs
657 void jtag_notify_event(enum jtag_event);
658
659
660 /* can be implemented by hw + sw */
661 extern int jtag_power_dropout(int* dropout);
662 extern int jtag_srst_asserted(int* srst_asserted);
663
664 /* JTAG support functions */
665
666 /**
667 * Execute jtag queue and check value with an optional mask.
668 * @param field Pointer to scan field.
669 * @param value Pointer to scan value.
670 * @param mask Pointer to scan mask; may be NULL.
671 * @returns Nothing, but calls jtag_set_error() on any error.
672 */
673 extern void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask);
674
675 extern void jtag_sleep(uint32_t us);
676
677 /*
678 * The JTAG subsystem defines a number of error codes,
679 * using codes between -100 and -199.
680 */
681 #define ERROR_JTAG_INIT_FAILED (-100)
682 #define ERROR_JTAG_INVALID_INTERFACE (-101)
683 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
684 #define ERROR_JTAG_TRST_ASSERTED (-103)
685 #define ERROR_JTAG_QUEUE_FAILED (-104)
686 #define ERROR_JTAG_NOT_STABLE_STATE (-105)
687 #define ERROR_JTAG_DEVICE_ERROR (-107)
688 #define ERROR_JTAG_STATE_INVALID (-108)
689 #define ERROR_JTAG_TRANSITION_INVALID (-109)
690
691 /**
692 * jtag_add_dr_out() is a version of jtag_add_dr_scan() which
693 * only scans data out. It operates on 32 bit integers instead
694 * of 8 bit, which makes it a better impedance match with
695 * the calling code which often operate on 32 bit integers.
696 *
697 * Current or end_state can not be TAP_RESET. end_state can be TAP_INVALID
698 *
699 * num_bits[i] is the number of bits to clock out from value[i] LSB first.
700 *
701 * If the device is in bypass, then that is an error condition in
702 * the caller code that is not detected by this fn, whereas
703 * jtag_add_dr_scan() does detect it. Similarly if the device is not in
704 * bypass, data must be passed to it.
705 *
706 * If anything fails, then jtag_error will be set and jtag_execute() will
707 * return an error. There is no way to determine if there was a failure
708 * during this function call.
709 *
710 * This is an inline fn to speed up embedded hosts. Also note that
711 * interface_jtag_add_dr_out() can be a *small* inline function for
712 * embedded hosts.
713 *
714 * There is no jtag_add_dr_outin() version of this fn that also allows
715 * clocking data back in. Patches gladly accepted!
716 */
717 extern void jtag_add_dr_out(jtag_tap_t* tap,
718 int num_fields, const int* num_bits, const uint32_t* value,
719 tap_state_t end_state);
720
721
722 /**
723 * Set the current JTAG core execution error, unless one was set
724 * by a previous call previously. Driver or application code must
725 * use jtag_error_clear to reset jtag_error once this routine has been
726 * called with a non-zero error code.
727 */
728 void jtag_set_error(int error);
729 /// @returns The current value of jtag_error
730 int jtag_get_error(void);
731 /**
732 * Resets jtag_error to ERROR_OK, returning its previous value.
733 * @returns The previous value of @c jtag_error.
734 */
735 int jtag_error_clear(void);
736
737 #endif /* JTAG_H */