7435617e0af245a9af78654c195de4be61c24122
[openocd.git] / src / jtag / jtag.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
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. *
9 * *
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. *
14 * *
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 ***************************************************************************/
20 #ifndef JTAG_H
21 #define JTAG_H
22
23 #include "types.h"
24 #include "binarybuffer.h"
25
26 #include "command.h"
27
28 #if 0
29 #define _DEBUG_JTAG_IO_
30 #endif
31
32 /* Tap States
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
38 */
39 enum tap_state
40 {
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
46 };
47
48 typedef struct tap_transition_s
49 {
50 enum tap_state high;
51 enum tap_state low;
52 } tap_transition_t;
53
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 */
58
59 extern enum tap_state end_state; /* finish DR scans in dr_end_state */
60 extern enum tap_state cur_state; /* current TAP state */
61
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 */
64
65 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
66
67 typedef void * error_handler_t; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */
68
69 struct scan_field_s;
70 typedef int (*in_handler_t)(u8 *in_value, void *priv, struct scan_field_s *field);
71
72 typedef struct scan_field_s
73 {
74 int device; /* ordinal device number this instruction refers to */
75 int num_bits; /* number of bits this field specifies (up to 32) */
76 u8 *out_value; /* value to be scanned into the device */
77 u8 *out_mask; /* only masked bits care */
78 u8 *in_value; /* pointer to a 32-bit memory location to take data scanned out */
79 /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage */
80 u8 *in_check_value; /* used to validate scan results */
81 u8 *in_check_mask; /* check specified bits against check_value */
82 in_handler_t in_handler; /* process received buffer using this handler */
83 void *in_handler_priv; /* additional information for the in_handler */
84 } scan_field_t;
85
86 enum scan_type
87 {
88 /* IN: from device to host, OUT: from host to device */
89 SCAN_IN = 1, SCAN_OUT = 2, SCAN_IO = 3
90 };
91
92 typedef struct scan_command_s
93 {
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 } scan_command_t;
99
100 typedef struct statemove_command_s
101 {
102 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
103 } statemove_command_t;
104
105 typedef struct pathmove_command_s
106 {
107 int num_states; /* number of states in *path */
108 enum tap_state *path; /* states that have to be passed */
109 } pathmove_command_t;
110
111 typedef struct runtest_command_s
112 {
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 */
115 } runtest_command_t;
116
117 typedef struct reset_command_s
118 {
119 int trst; /* trst/srst 0: deassert, 1: assert, -1: don't change */
120 int srst;
121 } reset_command_t;
122
123 typedef struct end_state_command_s
124 {
125 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
126 } end_state_command_t;
127
128 typedef struct sleep_command_s
129 {
130 u32 us; /* number of microseconds to sleep */
131 } sleep_command_t;
132
133 typedef union jtag_command_container_u
134 {
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;
143
144 enum jtag_command_type
145 {
146 JTAG_SCAN = 1,
147 JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3,
148 JTAG_RESET = 4, JTAG_END_STATE = 5,
149 JTAG_PATHMOVE = 6, JTAG_SLEEP = 7
150 };
151
152 typedef struct jtag_command_s
153 {
154 jtag_command_container_t cmd;
155 enum jtag_command_type type;
156 struct jtag_command_s *next;
157 } jtag_command_t;
158
159 extern jtag_command_t *jtag_command_queue;
160
161 typedef struct jtag_device_s
162 {
163 int ir_length; /* size of instruction register */
164 u8 *expected; /* Capture-IR expected value */
165 u8 *expected_mask; /* Capture-IR expected mask */
166 u32 idcode; /* device identification code */
167 u8 *cur_instr; /* current instruction */
168 int bypass; /* bypass register selected */
169 struct jtag_device_s *next;
170 } jtag_device_t;
171
172 extern jtag_device_t *jtag_devices;
173 extern int jtag_num_devices;
174 extern int jtag_ir_scan_size;
175
176 enum reset_line_mode
177 {
178 LINE_OPEN_DRAIN = 0x0,
179 LINE_PUSH_PULL = 0x1,
180 };
181
182 typedef struct jtag_interface_s
183 {
184 char* name;
185
186 /* queued command execution
187 */
188 int (*execute_queue)(void);
189
190 /* interface initalization
191 */
192 int (*speed)(int speed);
193 int (*register_commands)(struct command_context_s *cmd_ctx);
194 int (*init)(void);
195 int (*quit)(void);
196
197 } jtag_interface_t;
198
199 enum jtag_event
200 {
201 JTAG_SRST_ASSERTED,
202 JTAG_TRST_ASSERTED,
203 JTAG_SRST_RELEASED,
204 JTAG_TRST_RELEASED,
205 };
206
207 extern char* jtag_event_strings[];
208
209 extern int jtag_trst;
210 extern int jtag_srst;
211
212 typedef struct jtag_event_callback_s
213 {
214 int (*callback)(enum jtag_event event, void *priv);
215 void *priv;
216 struct jtag_event_callback_s *next;
217 } jtag_event_callback_t;
218
219 extern jtag_event_callback_t *jtag_event_callbacks;
220
221 extern jtag_interface_t *jtag; /* global pointer to configured JTAG interface */
222 extern enum tap_state end_state;
223 extern enum tap_state cur_state;
224
225 extern char* jtag_interface;
226 extern int jtag_speed;
227
228 enum reset_types
229 {
230 RESET_NONE = 0x0,
231 RESET_HAS_TRST = 0x1,
232 RESET_HAS_SRST = 0x2,
233 RESET_TRST_AND_SRST = 0x3,
234 RESET_SRST_PULLS_TRST = 0x4,
235 RESET_TRST_PULLS_SRST = 0x8,
236 RESET_TRST_OPEN_DRAIN = 0x10,
237 RESET_SRST_PUSH_PULL = 0x20,
238 };
239
240 extern enum reset_types jtag_reset_config;
241
242 /* JTAG subsystem */
243 extern int jtag_init(struct command_context_s *cmd_ctx);
244 extern int jtag_register_commands(struct command_context_s *cmd_ctx);
245
246 /* JTAG interface */
247 extern int jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate, void *dummy_anachronism);
248 extern int jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate, void *dummy_anachronism);
249 extern int jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate, void *dummy_anachronism);
250 extern int jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate, void *dummy_anachronism);
251 extern int jtag_add_statemove(enum tap_state endstate);
252 extern int jtag_add_pathmove(int num_states, enum tap_state *path);
253 extern int jtag_add_runtest(int num_cycles, enum tap_state endstate);
254 extern int jtag_add_reset(int trst, int srst);
255 extern int jtag_add_end_state(enum tap_state endstate);
256 extern int jtag_add_sleep(u32 us);
257 extern int jtag_execute_queue(void);
258 extern int jtag_cancel_queue(void);
259
260 /* JTAG support functions */
261 extern void jtag_set_check_value(scan_field_t *field, u8 *value, u8 *mask, error_handler_t *in_error_handler);
262 extern enum scan_type jtag_scan_type(scan_command_t *cmd);
263 extern int jtag_scan_size(scan_command_t *cmd);
264 extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd);
265 extern int jtag_build_buffer(scan_command_t *cmd, u8 **buffer);
266 extern jtag_device_t* jtag_get_device(int num);
267 extern void jtag_sleep(u32 us);
268 extern int jtag_call_event_callbacks(enum jtag_event event);
269 extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv);
270
271 extern int jtag_verify_capture_ir;
272
273
274 /* error codes
275 * JTAG subsystem uses codes between -100 and -199 */
276
277 #define ERROR_JTAG_INIT_FAILED (-100)
278 #define ERROR_JTAG_INVALID_INTERFACE (-101)
279 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
280 #define ERROR_JTAG_TRST_ASSERTED (-103)
281 #define ERROR_JTAG_QUEUE_FAILED (-104)
282 #define ERROR_JTAG_RESET_WOULD_ASSERT_TRST (-105)
283 #define ERROR_JTAG_RESET_CANT_SRST (-106)
284 #define ERROR_JTAG_DEVICE_ERROR (-107)
285 #endif /* JTAG_H */

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)