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 extern enum tap_state cmd_queue_end_state
; /* finish DR scans in dr_end_state */
63 extern enum tap_state cmd_queue_cur_state
; /* current TAP state */
65 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
67 typedef struct error_handler_s
69 int (*error_handler
)(u8
*in_value
, void *priv
); /* handle failed checks */
70 void *error_handler_priv
; /* additional information for the check_handler */
73 typedef struct scan_field_s
75 int device
; /* ordinal device number this instruction refers to */
76 int num_bits
; /* number of bits this field specifies (up to 32) */
77 u8
*out_value
; /* value to be scanned into the device */
78 u8
*out_mask
; /* only masked bits care */
79 u8
*in_value
; /* pointer to a 32-bit memory location to take data scanned out */
80 u8
*in_check_value
; /* used to validate scan results */
81 u8
*in_check_mask
; /* check specified bits against check_value */
82 int (*in_handler
)(u8
*in_value
, void *priv
); /* process received buffer using this handler */
83 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 */
98 error_handler_t
*error_handler
;
101 typedef struct statemove_command_s
103 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
104 } statemove_command_t
;
106 typedef struct pathmove_command_s
108 int num_states
; /* number of states in *path */
109 enum tap_state
*path
; /* states that have to be passed */
110 } pathmove_command_t
;
112 typedef struct runtest_command_s
114 int num_cycles
; /* number of cycles that should be spent in Run-Test/Idle */
115 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
118 typedef struct reset_command_s
120 int trst
; /* trst/srst 0: deassert, 1: assert, -1: don't change */
124 typedef struct end_state_command_s
126 enum tap_state end_state
; /* TAP state in which JTAG commands should finish */
127 } end_state_command_t
;
129 typedef struct sleep_command_s
131 u32 us
; /* number of microseconds to sleep */
134 typedef union jtag_command_container_u
136 scan_command_t
*scan
;
137 statemove_command_t
*statemove
;
138 pathmove_command_t
*pathmove
;
139 runtest_command_t
*runtest
;
140 reset_command_t
*reset
;
141 end_state_command_t
*end_state
;
142 sleep_command_t
*sleep
;
143 } jtag_command_container_t
;
145 enum jtag_command_type
148 JTAG_STATEMOVE
= 2, JTAG_RUNTEST
= 3,
149 JTAG_RESET
= 4, JTAG_END_STATE
= 5,
150 JTAG_PATHMOVE
= 6, JTAG_SLEEP
= 7
153 typedef struct jtag_command_s
155 jtag_command_container_t cmd
;
156 enum jtag_command_type type
;
157 struct jtag_command_s
*next
;
160 extern jtag_command_t
*jtag_command_queue
;
162 typedef struct jtag_device_s
164 int ir_length
; /* size of instruction register */
165 u8
*expected
; /* Capture-IR expected value */
166 u8
*expected_mask
; /* Capture-IR expected mask */
167 u32 idcode
; /* device identification code */
168 u8
*cur_instr
; /* current instruction */
169 int bypass
; /* bypass register selected */
170 struct jtag_device_s
*next
;
173 extern jtag_device_t
*jtag_devices
;
174 extern int jtag_num_devices
;
175 extern int jtag_ir_scan_size
;
179 LINE_OPEN_DRAIN
= 0x0,
180 LINE_PUSH_PULL
= 0x1,
183 typedef struct jtag_interface_s
187 /* queued command execution
189 int (*execute_queue
)(void);
191 /* optional command support
193 int support_pathmove
;
195 /* interface initalization
197 int (*speed
)(int speed
);
198 int (*register_commands
)(struct command_context_s
*cmd_ctx
);
212 extern char* jtag_event_strings
[];
214 extern int jtag_trst
;
215 extern int jtag_srst
;
217 typedef struct jtag_event_callback_s
219 int (*callback
)(enum jtag_event event
, void *priv
);
221 struct jtag_event_callback_s
*next
;
222 } jtag_event_callback_t
;
224 extern jtag_event_callback_t
*jtag_event_callbacks
;
226 extern jtag_interface_t
*jtag
; /* global pointer to configured JTAG interface */
227 extern enum tap_state end_state
;
228 extern enum tap_state cur_state
;
230 extern char* jtag_interface
;
231 extern int jtag_speed
;
236 RESET_HAS_TRST
= 0x1,
237 RESET_HAS_SRST
= 0x2,
238 RESET_TRST_AND_SRST
= 0x3,
239 RESET_SRST_PULLS_TRST
= 0x4,
240 RESET_TRST_PULLS_SRST
= 0x8,
241 RESET_TRST_OPEN_DRAIN
= 0x10,
242 RESET_SRST_PUSH_PULL
= 0x20,
245 extern enum reset_types jtag_reset_config
;
248 extern int jtag_init(struct command_context_s
*cmd_ctx
);
249 extern int jtag_register_commands(struct command_context_s
*cmd_ctx
);
252 extern int jtag_add_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
, error_handler_t
*error_handler
);
253 extern int jtag_add_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
, error_handler_t
*error_handler
);
254 extern int jtag_add_plain_ir_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
, error_handler_t
*error_handler
);
255 extern int jtag_add_plain_dr_scan(int num_fields
, scan_field_t
*fields
, enum tap_state endstate
, error_handler_t
*error_handler
);
256 extern int jtag_add_statemove(enum tap_state endstate
);
257 extern int jtag_add_pathmove(int num_states
, enum tap_state
*path
);
258 extern int jtag_add_runtest(int num_cycles
, enum tap_state endstate
);
259 extern int jtag_add_reset(int trst
, int srst
);
260 extern int jtag_add_end_state(enum tap_state endstate
);
261 extern int jtag_add_sleep(u32 us
);
262 extern int jtag_execute_queue(void);
263 extern int jtag_cancel_queue(void);
265 /* JTAG support functions */
266 extern enum scan_type
jtag_scan_type(scan_command_t
*cmd
);
267 extern int jtag_scan_size(scan_command_t
*cmd
);
268 extern int jtag_read_buffer(u8
*buffer
, scan_command_t
*cmd
);
269 extern int jtag_build_buffer(scan_command_t
*cmd
, u8
**buffer
);
270 extern jtag_device_t
* jtag_get_device(int num
);
271 extern void jtag_sleep(u32 us
);
272 extern int jtag_call_event_callbacks(enum jtag_event event
);
273 extern int jtag_register_event_callback(int (*callback
)(enum jtag_event event
, void *priv
), void *priv
);
276 * JTAG subsystem uses codes between -100 and -199 */
278 #define ERROR_JTAG_INIT_FAILED (-100)
279 #define ERROR_JTAG_INVALID_INTERFACE (-101)
280 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
281 #define ERROR_JTAG_TRST_ASSERTED (-103)
282 #define ERROR_JTAG_QUEUE_FAILED (-104)
283 #define ERROR_JTAG_RESET_WOULD_ASSERT_TRST (-105)
284 #define ERROR_JTAG_RESET_CANT_SRST (-106)
285 #define ERROR_JTAG_DEVICE_ERROR (-107)
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)