1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
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. *
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. *
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 ***************************************************************************/
27 #include "binarybuffer.h"
33 #define _DEBUG_JTAG_IO_
36 /* 16 Tap States, from page 21 of ASSET InterTech, Inc.'s svf.pdf
40 TAP_RESET
= 0x0, TAP_IDLE
= 0x8,
41 TAP_DRSELECT
= 0x1, TAP_DRCAPTURE
= 0x2, TAP_DRSHIFT
= 0x3, TAP_DREXIT1
= 0x4,
42 TAP_DRPAUSE
= 0x5, TAP_DREXIT2
= 0x6, TAP_DRUPDATE
= 0x7,
43 TAP_IRSELECT
= 0x9, TAP_IRCAPTURE
= 0xa, TAP_IRSHIFT
= 0xb, TAP_IREXIT1
= 0xc,
44 TAP_IRPAUSE
= 0xd, TAP_IREXIT2
= 0xe, TAP_IRUPDATE
= 0xf
47 typedef struct tap_transition_s
53 extern char* tap_state_strings
[16];
54 extern int tap_move_map
[16]; /* map 16 TAP states to 6 stable states */
55 extern u8 tap_move
[6][6]; /* value scanned to TMS to move from one of six stable states to another */
56 extern tap_transition_t tap_transitions
[16]; /* describe the TAP state diagram */
58 extern enum tap_state end_state
; /* finish DR scans in dr_end_state */
59 extern enum tap_state cur_state
; /* current TAP state */
61 extern enum tap_state cmd_queue_end_state
; /* finish DR scans in dr_end_state */
62 extern enum tap_state cmd_queue_cur_state
; /* current TAP state */
64 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
66 typedef void * error_handler_t
; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */
69 typedef int (*in_handler_t
)(u8
*in_value
, void *priv
, struct scan_field_s
*field
);
71 typedef struct scan_field_s
73 jtag_tap_t
*tap
; /* tap pointer this instruction refers to */
74 int num_bits
; /* number of bits this field specifies (up to 32) */
75 u8
*out_value
; /* value to be scanned into the device */
76 u8
*out_mask
; /* only masked bits care */
77 u8
*in_value
; /* pointer to a 32-bit memory location to take data scanned out */
78 /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage */
79 u8
*in_check_value
; /* used to validate scan results */
80 u8
*in_check_mask
; /* check specified bits against check_value */
81 in_handler_t in_handler
; /* process received buffer using this handler */
82 void *in_handler_priv
; /* additional information for the in_handler */
88 /* IN: from device to host, OUT: from host to device */
89 SCAN_IN
= 1, SCAN_OUT
= 2, SCAN_IO
= 3
92 typedef struct scan_command_s
94 int ir_scan
; /* instruction/not data scan */
95 int num_fields
; /* number of fields in *fields array */
96 scan_field_t
*fields
; /* pointer to an array of data scan fields */
97 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
100 typedef struct statemove_command_s
102 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
103 } statemove_command_t
;
105 typedef struct pathmove_command_s
107 int num_states
; /* number of states in *path */
108 enum tap_state
*path
; /* states that have to be passed */
109 } pathmove_command_t
;
111 typedef struct runtest_command_s
113 int num_cycles
; /* number of cycles that should be spent in Run-Test/Idle */
114 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
117 typedef struct reset_command_s
119 int trst
; /* trst/srst 0: deassert, 1: assert, -1: don't change */
123 typedef struct end_state_command_s
125 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
126 } end_state_command_t
;
128 typedef struct sleep_command_s
130 u32 us
; /* number of microseconds to sleep */
133 typedef union jtag_command_container_u
135 scan_command_t
*scan
;
136 statemove_command_t
*statemove
;
137 pathmove_command_t
*pathmove
;
138 runtest_command_t
*runtest
;
139 reset_command_t
*reset
;
140 end_state_command_t
*end_state
;
141 sleep_command_t
*sleep
;
142 } jtag_command_container_t
;
144 enum jtag_command_type
147 JTAG_STATEMOVE
= 2, JTAG_RUNTEST
= 3,
148 JTAG_RESET
= 4, JTAG_END_STATE
= 5,
149 JTAG_PATHMOVE
= 6, JTAG_SLEEP
= 7
152 typedef struct jtag_command_s
154 jtag_command_container_t cmd
;
155 enum jtag_command_type type
;
156 struct jtag_command_s
*next
;
159 extern jtag_command_t
*jtag_command_queue
;
161 // forward declaration
162 typedef struct jtag_tap_event_action_s jtag_tap_event_action_t
;
164 // this is really: typedef jtag_tap_t
165 // But - the typedef is done in "types.h"
166 // due to "forward decloration reasons"
171 const char *dotted_name
;
172 int abs_chain_position
;
174 int ir_length
; /* size of instruction register */
175 u32 ir_capture_value
;
176 u8
*expected
; /* Capture-IR expected value */
178 u8
*expected_mask
; /* Capture-IR expected mask */
179 u32 idcode
; /* device identification code */
180 u32
*expected_ids
; /* Array of expected identification codes */
181 u8 expected_ids_cnt
;/* Number of expected identification codes */
182 u8
*cur_instr
; /* current instruction */
183 int bypass
; /* bypass register selected */
185 jtag_tap_event_action_t
*event_action
;
187 jtag_tap_t
*next_tap
;
189 extern jtag_tap_t
*jtag_AllTaps(void);
190 extern jtag_tap_t
*jtag_TapByPosition(int n
);
191 extern jtag_tap_t
*jtag_TapByPosition( int n
);
192 extern jtag_tap_t
*jtag_TapByString( const char *dotted_name
);
193 extern jtag_tap_t
*jtag_TapByJimObj( Jim_Interp
*interp
, Jim_Obj
*obj
);
194 extern jtag_tap_t
*jtag_TapByAbsPosition( int abs_position
);
195 extern int jtag_NumEnabledTaps(void);
196 extern int jtag_NumTotalTaps(void);
199 static __inline__ jtag_tap_t
*
200 jtag_NextEnabledTap( jtag_tap_t
*p
)
203 // start at the head of list
206 // start *after* this one
224 LINE_OPEN_DRAIN
= 0x0,
225 LINE_PUSH_PULL
= 0x1,
228 typedef struct jtag_interface_s
232 /* queued command execution
234 int (*execute_queue
)(void);
236 /* interface initalization
238 int (*speed
)(int speed
);
239 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
242 /* returns JTAG maxium speed for KHz. 0=RTCK. The function returns
243 a failure if it can't support the KHz/RTCK.
245 WARNING!!!! if RTCK is *slow* then think carefully about
246 whether you actually want to support this in the driver.
247 Many target scripts are written to handle the absence of RTCK
248 and use a fallback kHz TCK.
250 int (*khz
)(int khz
, int *jtag_speed
);
251 /* returns the KHz for the provided JTAG speed. 0=RTCK. The function returns
252 a failure if it can't support the KHz/RTCK. */
253 int (*speed_div
)(int speed
, int *khz
);
255 /* Read and clear the power dropout flag. Note that a power dropout
256 can be transitionary, easily much less than a ms.
258 So to find out if the power is *currently* on, you must invoke
259 this method twice. Once to clear the power dropout flag and a
260 second time to read the current state.
262 Currently the default implementation is never to detect power dropout.
264 int (*power_dropout
)(int *power_dropout
);
265 /* Read and clear the srst asserted detection flag.
267 * NB!!!! like power_dropout this does *not* read the current
268 * state. srst assertion is transitionary and *can* be much
271 int (*srst_asserted
)(int *srst_asserted
);
280 extern char * jtag_event_strings
[];
284 JTAG_TAP_EVENT_ENABLE
,
285 JTAG_TAP_EVENT_DISABLE
288 extern const Jim_Nvp nvp_jtag_tap_event
[];
290 struct jtag_tap_event_action_s
{
291 enum jtag_tap_event event
;
293 jtag_tap_event_action_t
*next
;
296 extern int jtag_trst
;
297 extern int jtag_srst
;
299 typedef struct jtag_event_callback_s
301 int (*callback
)(enum jtag_event event
, void *priv
);
303 struct jtag_event_callback_s
*next
;
304 } jtag_event_callback_t
;
306 extern jtag_event_callback_t
*jtag_event_callbacks
;
308 extern jtag_interface_t
*jtag
; /* global pointer to configured JTAG interface */
309 extern enum tap_state end_state
;
310 extern enum tap_state cur_state
;
312 extern int jtag_speed
;
313 extern int jtag_speed_post_reset
;
318 RESET_HAS_TRST
= 0x1,
319 RESET_HAS_SRST
= 0x2,
320 RESET_TRST_AND_SRST
= 0x3,
321 RESET_SRST_PULLS_TRST
= 0x4,
322 RESET_TRST_PULLS_SRST
= 0x8,
323 RESET_TRST_OPEN_DRAIN
= 0x10,
324 RESET_SRST_PUSH_PULL
= 0x20,
327 extern enum reset_types jtag_reset_config
;
329 /* initialize interface upon startup. A successful no-op
330 * upon subsequent invocations
332 extern int jtag_interface_init(struct command_context_s
*cmd_ctx
);
333 /* initialize JTAG chain using only a RESET reset. If init fails,
336 extern int jtag_init(struct command_context_s
*cmd_ctx
);
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
);
341 /* JTAG interface, can be implemented with a software or hardware fifo
343 * TAP_DRSHIFT and TAP_IRSHIFT are illegal end states. TAP_DRSHIFT/IRSHIFT as end states
344 * can be emulated by using a larger scan.
346 * Code that is relatively insensitive to the path(as long
347 * as it is JTAG compliant) taken through state machine can use
348 * endstate for jtag_add_xxx_scan(). Otherwise the pause state must be
349 * specified as end state and a subsequent jtag_add_pathmove() must
353 extern void jtag_add_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
354 extern int interface_jtag_add_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
355 extern void jtag_add_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
356 extern int interface_jtag_add_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
357 extern void jtag_add_plain_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
358 extern int interface_jtag_add_plain_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
359 extern void jtag_add_plain_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
360 extern int interface_jtag_add_plain_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
361 /* run a TAP_RESET reset. End state is TAP_RESET, regardless
364 extern void jtag_add_tlr(void);
365 extern int interface_jtag_add_tlr(void);
366 /* Do not use jtag_add_pathmove() unless you need to, but do use it
369 * DANGER! If the target is dependent upon a particular sequence
370 * of transitions for things to work correctly(e.g. as a workaround
371 * for an errata that contradicts the JTAG standard), then pathmove
372 * must be used, even if some jtag interfaces happen to use the
373 * desired path. Worse, the jtag interface used for testing a
374 * particular implementation, could happen to use the "desired"
375 * path when transitioning to/from end
378 * A list of unambigious single clock state transitions, not
379 * all drivers can support this, but it is required for e.g.
380 * XScale and Xilinx support
382 * Note! TAP_RESET must not be used in the path!
384 * Note that the first on the list must be reachable
385 * via a single transition from the current state.
387 * All drivers are required to implement jtag_add_pathmove().
388 * However, if the pathmove sequence can not be precisely
389 * executed, an interface_jtag_add_pathmove() or jtag_execute_queue()
390 * must return an error. It is legal, but not recommended, that
391 * a driver returns an error in all cases for a pathmove if it
392 * can only implement a few transitions and therefore
393 * a partial implementation of pathmove would have little practical
396 extern void jtag_add_pathmove(int num_states
, enum tap_state
*path
);
397 extern int interface_jtag_add_pathmove(int num_states
, enum tap_state
*path
);
398 /* go to TAP_IDLE, if we're not already there and cycle
399 * precisely num_cycles in the TAP_IDLE after which move
400 * to the end state, if it is != TAP_IDLE
402 * nb! num_cycles can be 0, in which case the fn will navigate
403 * to endstate via TAP_IDLE
405 extern void jtag_add_runtest(int num_cycles
, enum tap_state endstate
);
406 extern int interface_jtag_add_runtest(int num_cycles
, enum tap_state endstate
);
407 /* A reset of the TAP state machine can be requested.
409 * Whether tms or trst reset is used depends on the capabilities of
410 * the target and jtag interface(reset_config command configures this).
412 * srst can driver a reset of the TAP state machine and vice
415 * Application code may need to examine value of jtag_reset_config
416 * to determine the proper codepath
418 * DANGER! Even though srst drives trst, trst might not be connected to
419 * the interface, and it might actually be *harmful* to assert trst in this case.
421 * This is why combinations such as "reset_config srst_only srst_pulls_trst"
424 * only req_tlr_or_trst and srst can have a transition for a
425 * call as the effects of transitioning both at the "same time"
426 * are undefined, but when srst_pulls_trst or vice versa,
427 * then trst & srst *must* be asserted together.
429 extern void jtag_add_reset(int req_tlr_or_trst
, int srst
);
430 /* this drives the actual srst and trst pins. srst will always be 0
431 * if jtag_reset_config & RESET_SRST_PULLS_TRST != 0 and ditto for
434 * the higher level jtag_add_reset will invoke jtag_add_tlr() if
437 extern int interface_jtag_add_reset(int trst
, int srst
);
438 extern void jtag_add_end_state(enum tap_state endstate
);
439 extern int interface_jtag_add_end_state(enum tap_state endstate
);
440 extern void jtag_add_sleep(u32 us
);
441 extern int interface_jtag_add_sleep(u32 us
);
446 * For software FIFO implementations, the queued commands can be executed
447 * during this call or earlier. A sw queue might decide to push out
448 * some of the jtag_add_xxx() operations once the queue is "big enough".
450 * This fn will return an error code if any of the prior jtag_add_xxx()
451 * calls caused a failure, e.g. check failure. Note that it does not
452 * matter if the operation was executed *before* jtag_execute_queue(),
453 * jtag_execute_queue() will still return an error code.
455 * All jtag_add_xxx() calls that have in_handler!=NULL will have been
456 * executed when this fn returns, but if what has been queued only
457 * clocks data out, without reading anything back, then JTAG could
458 * be running *after* jtag_execute_queue() returns. The API does
459 * not define a way to flush a hw FIFO that runs *after*
460 * jtag_execute_queue() returns.
462 * jtag_add_xxx() commands can either be executed immediately or
463 * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
465 extern int jtag_execute_queue(void);
466 /* can be implemented by hw+sw */
467 extern int interface_jtag_execute_queue(void);
468 extern int jtag_power_dropout(int *dropout
);
469 extern int jtag_srst_asserted(int *srst_asserted
);
472 /* JTAG support functions */
473 extern void jtag_set_check_value(scan_field_t
*field
, u8
*value
, u8
*mask
, error_handler_t
*in_error_handler
);
474 extern enum scan_type
jtag_scan_type(scan_command_t
*cmd
);
475 extern int jtag_scan_size(scan_command_t
*cmd
);
476 extern int jtag_read_buffer(u8
*buffer
, scan_command_t
*cmd
);
477 extern int jtag_build_buffer(scan_command_t
*cmd
, u8
**buffer
);
479 extern void jtag_sleep(u32 us
);
480 extern int jtag_call_event_callbacks(enum jtag_event event
);
481 extern int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
);
483 extern int jtag_verify_capture_ir
;
485 void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
);
488 * JTAG subsystem uses codes between -100 and -199 */
490 #define ERROR_JTAG_INIT_FAILED (-100)
491 #define ERROR_JTAG_INVALID_INTERFACE (-101)
492 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
493 #define ERROR_JTAG_TRST_ASSERTED (-103)
494 #define ERROR_JTAG_QUEUE_FAILED (-104)
495 #define ERROR_JTAG_DEVICE_ERROR (-107)
499 /* this allows JTAG devices to implement the entire jtag_xxx() layer in hw/sw */
500 #ifdef HAVE_JTAG_MINIDRIVER_H
501 /* Here a #define MINIDRIVER() and an inline version of hw fifo interface_jtag_add_dr_out can be defined */
502 #include "jtag_minidriver.h"
503 #define MINIDRIVER(a) notused ## a
505 #define MINIDRIVER(a) a
506 /* jtag_add_dr_out() is a faster version of jtag_add_dr_scan()
508 * Current or end_state can not be TAP_RESET. end_state can be -1
510 * num_bits[i] is the number of bits to clock out from value[i] LSB first.
512 * If the device is in bypass, then that is an error condition in
513 * the caller code that is not detected by this fn, whereas jtag_add_dr_scan()
514 * does detect it. Similarly if the device is not in bypass, data must
517 * If anything fails, then jtag_error will be set and jtag_execute() will
518 * return an error. There is no way to determine if there was a failure
519 * during this function call.
521 * Note that this jtag_add_dr_out can be defined as an inline function.
523 extern void interface_jtag_add_dr_out(jtag_tap_t
*tap
,
527 enum tap_state end_state
);
533 static __inline__
void jtag_add_dr_out(jtag_tap_t
*tap
,
537 enum tap_state end_state
)
540 cmd_queue_end_state
=end_state
;
541 cmd_queue_cur_state
=cmd_queue_end_state
;
542 interface_jtag_add_dr_out(tap
, num_fields
, num_bits
, value
, cmd_queue_end_state
);
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)