1dfefdef595da991ce8836dfe9d8e0fb5716a382
[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 ...) \
32 do { if (1) LOG_DEBUG(expr); } while (0)
33 #else
34 #define DEBUG_JTAG_IO(expr ...) \
35 do { if (0) LOG_DEBUG(expr); } while (0)
36 #endif
37
38 #ifndef DEBUG_JTAG_IOZ
39 #define DEBUG_JTAG_IOZ 64
40 #endif
41
42 /*-----<Macros>--------------------------------------------------*/
43
44 /**
45 * When given an array, compute its DIMension; in other words, the
46 * number of elements in the array
47 */
48 #define DIM(x) (sizeof(x)/sizeof((x)[0]))
49
50 /** Calculate the number of bytes required to hold @a n TAP scan bits */
51 #define TAP_SCAN_BYTES(n) CEIL(n, 8)
52
53 /*-----</Macros>-------------------------------------------------*/
54
55 /**
56 * Defines JTAG Test Access Port states.
57 *
58 * These definitions were gleaned from the ARM7TDMI-S Technical
59 * Reference Manual and validated against several other ARM core
60 * technical manuals.
61 *
62 * FIXME some interfaces require specific numbers be used, as they
63 * are handed-off directly to their hardware implementations.
64 * Fix those drivers to map as appropriate ... then pick some
65 * sane set of numbers here (where 0/uninitialized == INVALID).
66 */
67 typedef enum tap_state
68 {
69 TAP_INVALID = -1,
70
71 #if BUILD_ZY1000
72 /* These are the old numbers. Leave as-is for now... */
73 TAP_RESET = 0, TAP_IDLE = 8,
74 TAP_DRSELECT = 1, TAP_DRCAPTURE = 2, TAP_DRSHIFT = 3, TAP_DREXIT1 = 4,
75 TAP_DRPAUSE = 5, TAP_DREXIT2 = 6, TAP_DRUPDATE = 7,
76 TAP_IRSELECT = 9, TAP_IRCAPTURE = 10, TAP_IRSHIFT = 11, TAP_IREXIT1 = 12,
77 TAP_IRPAUSE = 13, TAP_IREXIT2 = 14, TAP_IRUPDATE = 15,
78
79 #else
80 /* Proper ARM recommended numbers */
81 TAP_DREXIT2 = 0x0,
82 TAP_DREXIT1 = 0x1,
83 TAP_DRSHIFT = 0x2,
84 TAP_DRPAUSE = 0x3,
85 TAP_IRSELECT = 0x4,
86 TAP_DRUPDATE = 0x5,
87 TAP_DRCAPTURE = 0x6,
88 TAP_DRSELECT = 0x7,
89 TAP_IREXIT2 = 0x8,
90 TAP_IREXIT1 = 0x9,
91 TAP_IRSHIFT = 0xa,
92 TAP_IRPAUSE = 0xb,
93 TAP_IDLE = 0xc,
94 TAP_IRUPDATE = 0xd,
95 TAP_IRCAPTURE = 0xe,
96 TAP_RESET = 0x0f,
97
98 #endif
99 } tap_state_t;
100
101 /**
102 * Function tap_state_name
103 * Returns a string suitable for display representing the JTAG tap_state
104 */
105 const char *tap_state_name(tap_state_t state);
106
107 /// Provides user-friendly name lookup of TAP states.
108 tap_state_t tap_state_by_name(const char *name);
109
110 /// The current TAP state of the pending JTAG command queue.
111 extern tap_state_t cmd_queue_cur_state;
112
113 /**
114 * This structure defines a single scan field in the scan. It provides
115 * fields for the field's width and pointers to scan input and output
116 * values.
117 *
118 * In addition, this structure includes a value and mask that is used by
119 * jtag_add_dr_scan_check() to validate the value that was scanned out.
120 *
121 * The allocated, modified, and intmp fields are internal work space.
122 */
123 typedef struct scan_field_s
124 {
125 /// A pointer to the tap structure to which this field refers.
126 jtag_tap_t* tap;
127
128 /// The number of bits this field specifies (up to 32)
129 int num_bits;
130 /// A pointer to value to be scanned into the device
131 uint8_t* out_value;
132 /// A pointer to a 32-bit memory location for data scanned out
133 uint8_t* in_value;
134
135 /// The value used to check the data scanned out.
136 uint8_t* check_value;
137 /// The mask to go with check_value
138 uint8_t* check_mask;
139
140 /// in_value has been allocated for the queue
141 int allocated;
142 /// Indicates we modified the in_value.
143 int modified;
144 /// temporary storage for performing value checks synchronously
145 uint8_t intmp[4];
146 } scan_field_t;
147
148 typedef struct jtag_tap_event_action_s jtag_tap_event_action_t;
149
150 /* this is really: typedef jtag_tap_t */
151 /* But - the typedef is done in "types.h" */
152 /* due to "forward declaration reasons" */
153 struct jtag_tap_s
154 {
155 const char* chip;
156 const char* tapname;
157 const char* dotted_name;
158 int abs_chain_position;
159 /// Is this TAP disabled after JTAG reset?
160 bool disabled_after_reset;
161 /// Is this TAP currently enabled?
162 bool enabled;
163 int ir_length; /**< size of instruction register */
164 uint32_t ir_capture_value;
165 uint8_t* expected; /**< Capture-IR expected value */
166 uint32_t ir_capture_mask;
167 uint8_t* expected_mask; /**< Capture-IR expected mask */
168 uint32_t idcode; /**< device identification code */
169 /** not all devices have idcode,
170 * we'll discover this during chain examination */
171 bool hasidcode;
172
173 /// Array of expected identification codes */
174 uint32_t* expected_ids;
175 /// Number of expected identification codes
176 uint8_t expected_ids_cnt;
177
178 /// current instruction
179 uint8_t* cur_instr;
180 /// Bypass register selected
181 int bypass;
182
183 jtag_tap_event_action_t *event_action;
184
185 jtag_tap_t* next_tap;
186 };
187
188 void jtag_tap_init(jtag_tap_t *tap);
189 void jtag_tap_free(jtag_tap_t *tap);
190
191 jtag_tap_t* jtag_all_taps(void);
192 const char *jtag_tap_name(const jtag_tap_t *tap);
193 jtag_tap_t* jtag_tap_by_string(const char* dotted_name);
194 jtag_tap_t* jtag_tap_by_jim_obj(Jim_Interp* interp, Jim_Obj* obj);
195 jtag_tap_t* jtag_tap_next_enabled(jtag_tap_t* p);
196 unsigned jtag_tap_count_enabled(void);
197 unsigned jtag_tap_count(void);
198
199
200 /*
201 * - TRST_ASSERTED triggers two sets of callbacks, after operations to
202 * reset the scan chain -- via TMS+TCK signaling, or deasserting the
203 * nTRST signal -- are queued:
204 *
205 * + Callbacks in C code fire first, patching internal state
206 * + Then post-reset event scripts fire ... activating JTAG circuits
207 * via TCK cycles, exiting SWD mode via TMS sequences, etc
208 *
209 * During those callbacks, scan chain contents have not been validated.
210 * JTAG operations that address a specific TAP (primarily DR/IR scans)
211 * must *not* be queued.
212 *
213 * - TAP_EVENT_SETUP is reported after TRST_ASSERTED, and after the scan
214 * chain has been validated. JTAG operations including scans that
215 * target specific TAPs may be performed.
216 *
217 * - TAP_EVENT_ENABLE and TAP_EVENT_DISABLE implement TAP activation and
218 * deactivation outside the core using scripted code that understands
219 * the specific JTAG router type. They might be triggered indirectly
220 * from EVENT_SETUP operations.
221 */
222 enum jtag_event {
223 JTAG_TRST_ASSERTED,
224 JTAG_TAP_EVENT_SETUP,
225 JTAG_TAP_EVENT_ENABLE,
226 JTAG_TAP_EVENT_DISABLE,
227 };
228
229 struct jtag_tap_event_action_s
230 {
231 enum jtag_event event;
232 Jim_Obj* body;
233 jtag_tap_event_action_t* next;
234 };
235
236 /**
237 * Defines the function signature requide for JTAG event callback
238 * functions, which are added with jtag_register_event_callback()
239 * and removed jtag_unregister_event_callback().
240 * @param event The event to handle.
241 * @param prive A pointer to data that was passed to
242 * jtag_register_event_callback().
243 * @returns Must return ERROR_OK on success, or an error code on failure.
244 *
245 * @todo Change to return void or define a use for its return code.
246 */
247 typedef int (*jtag_event_handler_t)(enum jtag_event event, void* priv);
248
249 int jtag_register_event_callback(jtag_event_handler_t f, void *x);
250 int jtag_unregister_event_callback(jtag_event_handler_t f, void *x);
251
252 int jtag_call_event_callbacks(enum jtag_event event);
253
254
255 /// @returns The current JTAG speed setting.
256 int jtag_get_speed(void);
257
258 /**
259 * Given a @a speed setting, use the interface @c speed_div callback to
260 * adjust the setting.
261 * @param speed The speed setting to convert back to readable KHz.
262 * @returns ERROR_OK if the interface has not been initialized or on success;
263 * otherwise, the error code produced by the @c speed_div callback.
264 */
265 int jtag_get_speed_readable(int *speed);
266
267 /// Attempt to configure the interface for the specified KHz.
268 int jtag_config_khz(unsigned khz);
269
270 /**
271 * Attempt to enable RTCK/RCLK. If that fails, fallback to the
272 * specified frequency.
273 */
274 int jtag_config_rclk(unsigned fallback_speed_khz);
275
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_NO_GATING = 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 int jtag_interface_init(struct command_context_s* cmd_ctx);
327
328 /// Shutdown the JTAG interface upon program exit.
329 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 int jtag_init(struct command_context_s* cmd_ctx);
336
337 /// reset, then initialize JTAG chain
338 int jtag_init_reset(struct command_context_s* cmd_ctx);
339 int jtag_register_commands(struct command_context_s* cmd_ctx);
340 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 void jtag_add_ir_scan(int num_fields,
368 scan_field_t* fields, tap_state_t endstate);
369 /**
370 * The same as jtag_add_ir_scan except no verification is performed out
371 * the output values.
372 */
373 void jtag_add_ir_scan_noverify(int num_fields,
374 const scan_field_t *fields, tap_state_t state);
375 /**
376 * Duplicate the scan fields passed into the function into an IR SCAN
377 * command. This function assumes that the caller handles extra fields
378 * for bypassed TAPs.
379 */
380 void jtag_add_plain_ir_scan(int num_fields,
381 const scan_field_t* fields, tap_state_t endstate);
382
383
384 /**
385 * Set in_value to point to 32 bits of memory to scan into. This
386 * function is a way to handle the case of synchronous and asynchronous
387 * JTAG queues.
388 *
389 * In the event of an asynchronous queue execution the queue buffer
390 * allocation method is used, for the synchronous case the temporary 32
391 * bits come from the input field itself.
392 */
393 void jtag_alloc_in_value32(scan_field_t *field);
394
395 /**
396 * Generate a DR SCAN using the fields passed to the function.
397 * For connected TAPs, the function checks in_fields and uses fields
398 * specified there. For bypassed TAPs, the function generates a dummy
399 * 1-bit field. The bypass status of TAPs is set by jtag_add_ir_scan().
400 */
401 void jtag_add_dr_scan(int num_fields,
402 const scan_field_t* fields, tap_state_t endstate);
403 /// A version of jtag_add_dr_scan() that uses the check_value/mask fields
404 void jtag_add_dr_scan_check(int num_fields,
405 scan_field_t* fields, tap_state_t endstate);
406 /**
407 * Duplicate the scan fields passed into the function into a DR SCAN
408 * command. Unlike jtag_add_dr_scan(), this function assumes that the
409 * caller handles extra fields for bypassed TAPs.
410 */
411 void jtag_add_plain_dr_scan(int num_fields,
412 const scan_field_t* fields, tap_state_t endstate);
413
414 /**
415 * Defines the type of data passed to the jtag_callback_t interface.
416 * The underlying type must allow storing an @c int or pointer type.
417 */
418 typedef intptr_t jtag_callback_data_t;
419
420 /**
421 * Defines a simple JTAG callback that can allow conversions on data
422 * scanned in from an interface.
423 *
424 * This callback should only be used for conversion that cannot fail.
425 * For conversion types or checks that can fail, use the more complete
426 * variant: jtag_callback_t.
427 */
428 typedef void (*jtag_callback1_t)(jtag_callback_data_t data0);
429
430 /// A simpler version of jtag_add_callback4().
431 void jtag_add_callback(jtag_callback1_t, jtag_callback_data_t data0);
432
433
434
435 /**
436 * Defines the interface of the JTAG callback mechanism.
437 *
438 * @param in the pointer to the data clocked in
439 * @param data1 An integer big enough to use as an @c int or a pointer.
440 * @param data2 An integer big enough to use as an @c int or a pointer.
441 * @param data3 An integer big enough to use as an @c int or a pointer.
442 * @returns an error code
443 */
444 typedef int (*jtag_callback_t)(jtag_callback_data_t data0,
445 jtag_callback_data_t data1,
446 jtag_callback_data_t data2,
447 jtag_callback_data_t data3);
448
449
450 /**
451 * This callback can be executed immediately the queue has been flushed.
452 *
453 * The JTAG queue can be executed synchronously or asynchronously.
454 * Typically for USB, the queue is executed asynchronously. For
455 * low-latency interfaces, the queue may be executed synchronously.
456 *
457 * The callback mechanism is very general and does not make many
458 * assumptions about what the callback does or what its arguments are.
459 * These callbacks are typically executed *after* the *entire* JTAG
460 * queue has been executed for e.g. USB interfaces, and they are
461 * guaranteeed to be invoked in the order that they were queued.
462 *
463 * If the execution of the queue fails before the callbacks, then --
464 * depending on driver implementation -- the callbacks may or may not be
465 * invoked. @todo Can we make this behavior consistent?
466 *
467 * The strange name is due to C's lack of overloading using function
468 * arguments.
469 *
470 * @param f The callback function to add.
471 * @param data0 Typically used to point to the data to operate on.
472 * Frequently this will be the data clocked in during a shift operation.
473 * @param data1 An integer big enough to use as an @c int or a pointer.
474 * @param data2 An integer big enough to use as an @c int or a pointer.
475 * @param data3 An integer big enough to use as an @c int or a pointer.
476 *
477 */
478 void jtag_add_callback4(jtag_callback_t f, jtag_callback_data_t data0,
479 jtag_callback_data_t data1, jtag_callback_data_t data2,
480 jtag_callback_data_t data3);
481
482
483 /**
484 * Run a TAP_RESET reset where the end state is TAP_RESET,
485 * regardless of the start state.
486 */
487 void jtag_add_tlr(void);
488
489 /**
490 * Application code *must* assume that interfaces will
491 * implement transitions between states with different
492 * paths and path lengths through the state diagram. The
493 * path will vary across interface and also across versions
494 * of the same interface over time. Even if the OpenOCD code
495 * is unchanged, the actual path taken may vary over time
496 * and versions of interface firmware or PCB revisions.
497 *
498 * Use jtag_add_pathmove() when specific transition sequences
499 * are required.
500 *
501 * Do not use jtag_add_pathmove() unless you need to, but do use it
502 * if you have to.
503 *
504 * DANGER! If the target is dependent upon a particular sequence
505 * of transitions for things to work correctly(e.g. as a workaround
506 * for an errata that contradicts the JTAG standard), then pathmove
507 * must be used, even if some jtag interfaces happen to use the
508 * desired path. Worse, the jtag interface used for testing a
509 * particular implementation, could happen to use the "desired"
510 * path when transitioning to/from end
511 * state.
512 *
513 * A list of unambigious single clock state transitions, not
514 * all drivers can support this, but it is required for e.g.
515 * XScale and Xilinx support
516 *
517 * Note! TAP_RESET must not be used in the path!
518 *
519 * Note that the first on the list must be reachable
520 * via a single transition from the current state.
521 *
522 * All drivers are required to implement jtag_add_pathmove().
523 * However, if the pathmove sequence can not be precisely
524 * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
525 * must return an error. It is legal, but not recommended, that
526 * a driver returns an error in all cases for a pathmove if it
527 * can only implement a few transitions and therefore
528 * a partial implementation of pathmove would have little practical
529 * application.
530 *
531 * If an error occurs, jtag_error will contain one of these error codes:
532 * - ERROR_JTAG_NOT_STABLE_STATE -- The final state was not stable.
533 * - ERROR_JTAG_STATE_INVALID -- The path passed through TAP_RESET.
534 * - ERROR_JTAG_TRANSITION_INVALID -- The path includes invalid
535 * state transitions.
536 */
537 void jtag_add_pathmove(int num_states, const tap_state_t* path);
538
539 /**
540 * jtag_add_statemove() moves from the current state to @a goal_state.
541 *
542 * @param goal_state The final TAP state.
543 * @return ERROR_OK on success, or an error code on failure.
544 *
545 * Moves from the current state to the goal \a state.
546 * Both states must be stable.
547 */
548 int jtag_add_statemove(tap_state_t goal_state);
549
550 /**
551 * Goes to TAP_IDLE (if we're not already there), cycle
552 * precisely num_cycles in the TAP_IDLE state, after which move
553 * to @a endstate (unless it is also TAP_IDLE).
554 *
555 * @param num_cycles Number of cycles in TAP_IDLE state. This argument
556 * may be 0, in which case this routine will navigate to @a endstate
557 * via TAP_IDLE.
558 * @param endstate The final state.
559 */
560 void jtag_add_runtest(int num_cycles, tap_state_t endstate);
561
562 /**
563 * A reset of the TAP state machine can be requested.
564 *
565 * Whether tms or trst reset is used depends on the capabilities of
566 * the target and jtag interface(reset_config command configures this).
567 *
568 * srst can driver a reset of the TAP state machine and vice
569 * versa
570 *
571 * Application code may need to examine value of jtag_reset_config
572 * to determine the proper codepath
573 *
574 * DANGER! Even though srst drives trst, trst might not be connected to
575 * the interface, and it might actually be *harmful* to assert trst in this case.
576 *
577 * This is why combinations such as "reset_config srst_only srst_pulls_trst"
578 * are supported.
579 *
580 * only req_tlr_or_trst and srst can have a transition for a
581 * call as the effects of transitioning both at the "same time"
582 * are undefined, but when srst_pulls_trst or vice versa,
583 * then trst & srst *must* be asserted together.
584 */
585 void jtag_add_reset(int req_tlr_or_trst, int srst);
586
587
588 /**
589 * Function jtag_set_end_state
590 *
591 * Set a global variable to \a state if \a state != TAP_INVALID.
592 *
593 * Return the value of the global variable.
594 *
595 **/
596 tap_state_t jtag_set_end_state(tap_state_t state);
597 /**
598 * Function jtag_get_end_state
599 *
600 * Return the value of the global variable for end state
601 *
602 **/
603 tap_state_t jtag_get_end_state(void);
604 void jtag_add_sleep(uint32_t us);
605
606
607 /**
608 * Function jtag_add_stable_clocks
609 * first checks that the state in which the clocks are to be issued is
610 * stable, then queues up clock_count clocks for transmission.
611 */
612 void jtag_add_clocks(int num_cycles);
613
614
615 /**
616 * For software FIFO implementations, the queued commands can be executed
617 * during this call or earlier. A sw queue might decide to push out
618 * some of the jtag_add_xxx() operations once the queue is "big enough".
619 *
620 * This fn will return an error code if any of the prior jtag_add_xxx()
621 * calls caused a failure, e.g. check failure. Note that it does not
622 * matter if the operation was executed *before* jtag_execute_queue(),
623 * jtag_execute_queue() will still return an error code.
624 *
625 * All jtag_add_xxx() calls that have in_handler != NULL will have been
626 * executed when this fn returns, but if what has been queued only
627 * clocks data out, without reading anything back, then JTAG could
628 * be running *after* jtag_execute_queue() returns. The API does
629 * not define a way to flush a hw FIFO that runs *after*
630 * jtag_execute_queue() returns.
631 *
632 * jtag_add_xxx() commands can either be executed immediately or
633 * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
634 */
635 int jtag_execute_queue(void);
636
637 /// same as jtag_execute_queue() but does not clear the error flag
638 void jtag_execute_queue_noclear(void);
639
640 /// @returns the number of times the scan queue has been flushed
641 int jtag_get_flush_queue_count(void);
642
643 /// Report Tcl event to all TAPs
644 void jtag_notify_event(enum jtag_event);
645
646
647 /* can be implemented by hw + sw */
648 int jtag_power_dropout(int* dropout);
649 int jtag_srst_asserted(int* srst_asserted);
650
651 /* JTAG support functions */
652
653 /**
654 * Execute jtag queue and check value with an optional mask.
655 * @param field Pointer to scan field.
656 * @param value Pointer to scan value.
657 * @param mask Pointer to scan mask; may be NULL.
658 * @returns Nothing, but calls jtag_set_error() on any error.
659 */
660 void jtag_check_value_mask(scan_field_t *field, uint8_t *value, uint8_t *mask);
661
662 void jtag_sleep(uint32_t us);
663
664 /*
665 * The JTAG subsystem defines a number of error codes,
666 * using codes between -100 and -199.
667 */
668 #define ERROR_JTAG_INIT_FAILED (-100)
669 #define ERROR_JTAG_INVALID_INTERFACE (-101)
670 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
671 #define ERROR_JTAG_TRST_ASSERTED (-103)
672 #define ERROR_JTAG_QUEUE_FAILED (-104)
673 #define ERROR_JTAG_NOT_STABLE_STATE (-105)
674 #define ERROR_JTAG_DEVICE_ERROR (-107)
675 #define ERROR_JTAG_STATE_INVALID (-108)
676 #define ERROR_JTAG_TRANSITION_INVALID (-109)
677 #define ERROR_JTAG_INIT_SOFT_FAIL (-110)
678
679 /**
680 * jtag_add_dr_out() is a version of jtag_add_dr_scan() which
681 * only scans data out. It operates on 32 bit integers instead
682 * of 8 bit, which makes it a better impedance match with
683 * the calling code which often operate on 32 bit integers.
684 *
685 * Current or end_state can not be TAP_RESET. end_state can be TAP_INVALID
686 *
687 * num_bits[i] is the number of bits to clock out from value[i] LSB first.
688 *
689 * If the device is in bypass, then that is an error condition in
690 * the caller code that is not detected by this fn, whereas
691 * jtag_add_dr_scan() does detect it. Similarly if the device is not in
692 * bypass, data must be passed to it.
693 *
694 * If anything fails, then jtag_error will be set and jtag_execute() will
695 * return an error. There is no way to determine if there was a failure
696 * during this function call.
697 *
698 * This is an inline fn to speed up embedded hosts. Also note that
699 * interface_jtag_add_dr_out() can be a *small* inline function for
700 * embedded hosts.
701 *
702 * There is no jtag_add_dr_outin() version of this fn that also allows
703 * clocking data back in. Patches gladly accepted!
704 */
705 void jtag_add_dr_out(jtag_tap_t* tap,
706 int num_fields, const int* num_bits, const uint32_t* value,
707 tap_state_t end_state);
708
709
710 /**
711 * Set the current JTAG core execution error, unless one was set
712 * by a previous call previously. Driver or application code must
713 * use jtag_error_clear to reset jtag_error once this routine has been
714 * called with a non-zero error code.
715 */
716 void jtag_set_error(int error);
717 /// @returns The current value of jtag_error
718 int jtag_get_error(void);
719 /**
720 * Resets jtag_error to ERROR_OK, returning its previous value.
721 * @returns The previous value of @c jtag_error.
722 */
723 int jtag_error_clear(void);
724
725 /**
726 * Return true if it's safe for a background polling task to access the
727 * JTAG scan chain. Polling may be explicitly disallowed, and is also
728 * unsafe while nTRST is active or the JTAG clock is gated off.,
729 */
730 bool is_jtag_poll_safe(void);
731
732 /**
733 * Return flag reporting whether JTAG polling is disallowed.
734 */
735 bool jtag_poll_get_enabled(void);
736
737 /**
738 * Assign flag reporting whether JTAG polling is disallowed.
739 */
740 void jtag_poll_set_enabled(bool value);
741
742 #endif /* JTAG_H */