1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
24 #include "binarybuffer.h"
29 #define _DEBUG_JTAG_IO_
33 * TLR - Test-Logic-Reset, RTI - Run-Test/Idle,
34 * SDS - Select-DR-Scan, CD - Capture-DR, SD - Shift-DR, E1D - Exit1-DR,
35 * PD - Pause-DR, E2D - Exit2-DR, UD - Update-DR,
36 * SIS - Select-IR-Scan, CI - Capture-IR, SI - Shift-IR, E1I - Exit1-IR,
37 * PI - Pause-IR, E2I - Exit2-IR, UI - Update-IR
41 TAP_TLR
= 0x0, TAP_RTI
= 0x8,
42 TAP_SDS
= 0x1, TAP_CD
= 0x2, TAP_SD
= 0x3, TAP_E1D
= 0x4,
43 TAP_PD
= 0x5, TAP_E2D
= 0x6, TAP_UD
= 0x7,
44 TAP_SIS
= 0x9, TAP_CI
= 0xa, TAP_SI
= 0xb, TAP_E1I
= 0xc,
45 TAP_PI
= 0xd, TAP_E2I
= 0xe, TAP_UI
= 0xf
48 typedef struct tap_transition_s
54 extern char* tap_state_strings
[16];
55 extern int tap_move_map
[16]; /* map 16 TAP states to 6 stable states */
56 extern u8 tap_move
[6][6]; /* value scanned to TMS to move from one of six stable states to another */
57 extern tap_transition_t tap_transitions
[16]; /* describe the TAP state diagram */
59 extern enum tap_state end_state
; /* finish DR scans in dr_end_state */
60 extern enum tap_state cur_state
; /* current TAP state */
62 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
64 typedef struct scan_field_s
66 int device
; /* ordinal device number this instruction refers to */
67 int num_bits
; /* number of bits this field specifies (up to 32) */
68 u8
*out_value
; /* value to be scanned into the device */
69 u8
*out_mask
; /* only masked bits care */
70 u8
*in_value
; /* pointer to a 32-bit memory location to take data scanned out */
71 u8
*in_check_value
; /* used to validate scan results */
72 u8
*in_check_mask
; /* check specified bits against check_value */
73 int (*in_handler
)(u8
*in_value
, void *priv
); /* process received buffer using this handler */
74 void *in_handler_priv
; /* additional information for the in_handler */
79 /* IN: from device to host, OUT: from host to device */
80 SCAN_IN
= 1, SCAN_OUT
= 2, SCAN_IO
= 3
83 typedef struct scan_command_s
85 int ir_scan
; /* instruction/not data scan */
86 int num_fields
; /* number of fields in *fields array */
87 scan_field_t
*fields
; /* pointer to an array of data scan fields */
88 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
91 typedef struct statemove_command_s
93 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
94 } statemove_command_t
;
96 typedef struct pathmove_command_s
98 int num_states
; /* number of states in *path */
99 enum tap_state
*path
; /* states that have to be passed */
100 } pathmove_command_t
;
102 typedef struct runtest_command_s
104 int num_cycles
; /* number of cycles that should be spent in Run-Test/Idle */
105 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
108 typedef struct reset_command_s
110 int trst
; /* trst/srst 0: deassert, 1: assert, -1: don't change */
114 typedef struct end_state_command_s
116 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
117 } end_state_command_t
;
119 typedef struct sleep_command_s
121 u32 us
; /* number of microseconds to sleep */
124 typedef union jtag_command_container_u
126 scan_command_t
*scan
;
127 statemove_command_t
*statemove
;
128 pathmove_command_t
*pathmove
;
129 runtest_command_t
*runtest
;
130 reset_command_t
*reset
;
131 end_state_command_t
*end_state
;
132 sleep_command_t
*sleep
;
133 } jtag_command_container_t
;
135 enum jtag_command_type
138 JTAG_STATEMOVE
= 2, JTAG_RUNTEST
= 3,
139 JTAG_RESET
= 4, JTAG_END_STATE
= 5,
140 JTAG_PATHMOVE
= 6, JTAG_SLEEP
= 7
143 typedef struct jtag_command_s
145 jtag_command_container_t cmd
;
146 enum jtag_command_type type
;
147 struct jtag_command_s
*next
;
150 extern jtag_command_t
*jtag_command_queue
;
152 typedef struct jtag_device_s
154 int ir_length
; /* size of instruction register */
155 u8
*expected
; /* Capture-IR expected value */
156 u8
*expected_mask
; /* Capture-IR expected mask */
157 u32 idcode
; /* device identification code */
158 u8
*cur_instr
; /* current instruction */
159 int bypass
; /* bypass register selected */
160 struct jtag_device_s
*next
;
163 extern jtag_device_t
*jtag_devices
;
164 extern int jtag_num_devices
;
165 extern int jtag_ir_scan_size
;
169 LINE_OPEN_DRAIN
= 0x0,
170 LINE_PUSH_PULL
= 0x1,
173 typedef struct jtag_interface_s
177 /* queued command execution
179 int (*execute_queue
)(void);
181 /* optional command support
183 int support_statemove
;
185 /* interface initalization
187 int (*speed
)(int speed
);
188 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
202 typedef struct jtag_event_callback_s
204 int (*callback
)(enum jtag_event event
, void *priv
);
206 struct jtag_event_callback_s
*next
;
207 } jtag_event_callback_t
;
209 extern jtag_event_callback_t
*jtag_event_callbacks
;
211 extern jtag_interface_t
*jtag
; /* global pointer to configured JTAG interface */
212 extern enum tap_state end_state
;
213 extern enum tap_state cur_state
;
215 extern char* jtag_interface
;
216 extern int jtag_speed
;
221 RESET_HAS_TRST
= 0x1,
222 RESET_HAS_SRST
= 0x2,
223 RESET_TRST_AND_SRST
= 0x3,
224 RESET_SRST_PULLS_TRST
= 0x4,
225 RESET_TRST_PULLS_SRST
= 0x8,
226 RESET_TRST_OPEN_DRAIN
= 0x10,
227 RESET_SRST_PUSH_PULL
= 0x20,
230 extern enum reset_types jtag_reset_config
;
233 extern int jtag_init(struct command_context_s
*cmd_ctx
);
234 extern int jtag_register_commands(struct command_context_s
*cmd_ctx
);
237 extern int jtag_add_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
238 extern int jtag_add_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
239 extern int jtag_add_plain_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
240 extern int jtag_add_plain_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
);
241 extern int jtag_add_statemove(enum tap_state endstate
);
242 extern int jtag_add_pathmove(int num_states
, enum tap_state
*path
);
243 extern int jtag_add_runtest(int num_cycles
, enum tap_state endstate
);
244 extern int jtag_add_reset(int trst
, int srst
);
245 extern int jtag_add_end_state(enum tap_state endstate
);
246 extern int jtag_add_sleep(u32 us
);
247 extern int jtag_execute_queue(void);
248 extern int jtag_cancel_queue(void);
250 /* JTAG support functions */
251 extern enum scan_type
jtag_scan_type(scan_command_t
*cmd
);
252 extern int jtag_scan_size(scan_command_t
*cmd
);
253 extern int jtag_read_buffer(u8
*buffer
, scan_command_t
*cmd
);
254 extern int jtag_build_buffer(scan_command_t
*cmd
, u8
**buffer
);
255 extern jtag_device_t
* jtag_get_device(int num
);
256 extern void jtag_sleep(u32 us
);
257 extern int jtag_call_event_callbacks(enum jtag_event event
);
258 extern int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
);
261 * JTAG subsystem uses codes between -100 and -199 */
263 #define ERROR_JTAG_INIT_FAILED (-100)
264 #define ERROR_JTAG_INVALID_INTERFACE (-101)
265 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
266 #define ERROR_JTAG_TRST_ASSERTED (-103)
267 #define ERROR_JTAG_QUEUE_FAILED (-104)
268 #define ERROR_JTAG_RESET_WOULD_ASSERT_TRST (-105)
269 #define ERROR_JTAG_RESET_CANT_SRST (-106)
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)