ada3b49dc874b7f1e30ac4f1a3bbd62715191f6c
[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 #include "log.h"
26
27 #include "command.h"
28
29 #if 0
30 #define _DEBUG_JTAG_IO_
31 #endif
32
33 /* Tap States
34 * TLR - Test-Logic-Reset, RTI - Run-Test/Idle,
35 * SDS - Select-DR-Scan, CD - Capture-DR, SD - Shift-DR, E1D - Exit1-DR,
36 * PD - Pause-DR, E2D - Exit2-DR, UD - Update-DR,
37 * SIS - Select-IR-Scan, CI - Capture-IR, SI - Shift-IR, E1I - Exit1-IR,
38 * PI - Pause-IR, E2I - Exit2-IR, UI - Update-IR
39 */
40 enum tap_state
41 {
42 TAP_TLR = 0x0, TAP_RTI = 0x8,
43 TAP_SDS = 0x1, TAP_CD = 0x2, TAP_SD = 0x3, TAP_E1D = 0x4,
44 TAP_PD = 0x5, TAP_E2D = 0x6, TAP_UD = 0x7,
45 TAP_SIS = 0x9, TAP_CI = 0xa, TAP_SI = 0xb, TAP_E1I = 0xc,
46 TAP_PI = 0xd, TAP_E2I = 0xe, TAP_UI = 0xf
47 };
48
49 typedef struct tap_transition_s
50 {
51 enum tap_state high;
52 enum tap_state low;
53 } tap_transition_t;
54
55 extern char* tap_state_strings[16];
56 extern int tap_move_map[16]; /* map 16 TAP states to 6 stable states */
57 extern u8 tap_move[6][6]; /* value scanned to TMS to move from one of six stable states to another */
58 extern tap_transition_t tap_transitions[16]; /* describe the TAP state diagram */
59
60 extern enum tap_state end_state; /* finish DR scans in dr_end_state */
61 extern enum tap_state cur_state; /* current TAP state */
62
63 extern enum tap_state cmd_queue_end_state; /* finish DR scans in dr_end_state */
64 extern enum tap_state cmd_queue_cur_state; /* current TAP state */
65
66 #define TAP_MOVE(from, to) tap_move[tap_move_map[from]][tap_move_map[to]]
67
68 typedef void * error_handler_t; /* Later on we can delete error_handler_t, but keep it for now to make patches more readable */
69
70 struct scan_field_s;
71 typedef int (*in_handler_t)(u8 *in_value, void *priv, struct scan_field_s *field);
72
73 typedef struct scan_field_s
74 {
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 /* in_check_value/mask, in_handler_error_handler, in_handler_priv can be used by the in handler, otherwise they contain garbage */
81 u8 *in_check_value; /* used to validate scan results */
82 u8 *in_check_mask; /* check specified bits against check_value */
83 in_handler_t in_handler; /* process received buffer using this handler */
84 void *in_handler_priv; /* additional information for the in_handler */
85 } scan_field_t;
86
87
88 enum scan_type
89 {
90 /* IN: from device to host, OUT: from host to device */
91 SCAN_IN = 1, SCAN_OUT = 2, SCAN_IO = 3
92 };
93
94 typedef struct scan_command_s
95 {
96 int ir_scan; /* instruction/not data scan */
97 int num_fields; /* number of fields in *fields array */
98 scan_field_t *fields; /* pointer to an array of data scan fields */
99 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
100 } scan_command_t;
101
102 typedef struct statemove_command_s
103 {
104 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
105 } statemove_command_t;
106
107 typedef struct pathmove_command_s
108 {
109 int num_states; /* number of states in *path */
110 enum tap_state *path; /* states that have to be passed */
111 } pathmove_command_t;
112
113 typedef struct runtest_command_s
114 {
115 int num_cycles; /* number of cycles that should be spent in Run-Test/Idle */
116 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
117 } runtest_command_t;
118
119 typedef struct reset_command_s
120 {
121 int trst; /* trst/srst 0: deassert, 1: assert, -1: don't change */
122 int srst;
123 } reset_command_t;
124
125 typedef struct end_state_command_s
126 {
127 enum tap_state end_state; /* TAP state in which JTAG commands should finish */
128 } end_state_command_t;
129
130 typedef struct sleep_command_s
131 {
132 u32 us; /* number of microseconds to sleep */
133 } sleep_command_t;
134
135 typedef union jtag_command_container_u
136 {
137 scan_command_t *scan;
138 statemove_command_t *statemove;
139 pathmove_command_t *pathmove;
140 runtest_command_t *runtest;
141 reset_command_t *reset;
142 end_state_command_t *end_state;
143 sleep_command_t *sleep;
144 } jtag_command_container_t;
145
146 enum jtag_command_type
147 {
148 JTAG_SCAN = 1,
149 JTAG_STATEMOVE = 2, JTAG_RUNTEST = 3,
150 JTAG_RESET = 4, JTAG_END_STATE = 5,
151 JTAG_PATHMOVE = 6, JTAG_SLEEP = 7
152 };
153
154 typedef struct jtag_command_s
155 {
156 jtag_command_container_t cmd;
157 enum jtag_command_type type;
158 struct jtag_command_s *next;
159 } jtag_command_t;
160
161 extern jtag_command_t *jtag_command_queue;
162
163 typedef struct jtag_device_s
164 {
165 int ir_length; /* size of instruction register */
166 u8 *expected; /* Capture-IR expected value */
167 u8 *expected_mask; /* Capture-IR expected mask */
168 u32 idcode; /* device identification code */
169 u8 *cur_instr; /* current instruction */
170 int bypass; /* bypass register selected */
171 struct jtag_device_s *next;
172 } jtag_device_t;
173
174 extern jtag_device_t *jtag_devices;
175 extern int jtag_num_devices;
176 extern int jtag_ir_scan_size;
177
178 enum reset_line_mode
179 {
180 LINE_OPEN_DRAIN = 0x0,
181 LINE_PUSH_PULL = 0x1,
182 };
183
184 typedef struct jtag_interface_s
185 {
186 char* name;
187
188 /* queued command execution
189 */
190 int (*execute_queue)(void);
191
192 /* interface initalization
193 */
194 int (*speed)(int speed);
195 int (*register_commands)(struct command_context_s *cmd_ctx);
196 int (*init)(void);
197 int (*quit)(void);
198
199 } jtag_interface_t;
200
201 enum jtag_event
202 {
203 JTAG_SRST_ASSERTED,
204 JTAG_TRST_ASSERTED,
205 JTAG_SRST_RELEASED,
206 JTAG_TRST_RELEASED,
207 };
208
209 extern char* jtag_event_strings[];
210
211 extern int jtag_trst;
212 extern int jtag_srst;
213
214 typedef struct jtag_event_callback_s
215 {
216 int (*callback)(enum jtag_event event, void *priv);
217 void *priv;
218 struct jtag_event_callback_s *next;
219 } jtag_event_callback_t;
220
221 extern jtag_event_callback_t *jtag_event_callbacks;
222
223 extern jtag_interface_t *jtag; /* global pointer to configured JTAG interface */
224 extern enum tap_state end_state;
225 extern enum tap_state cur_state;
226
227 extern int jtag_speed;
228
229 enum reset_types
230 {
231 RESET_NONE = 0x0,
232 RESET_HAS_TRST = 0x1,
233 RESET_HAS_SRST = 0x2,
234 RESET_TRST_AND_SRST = 0x3,
235 RESET_SRST_PULLS_TRST = 0x4,
236 RESET_TRST_PULLS_SRST = 0x8,
237 RESET_TRST_OPEN_DRAIN = 0x10,
238 RESET_SRST_PUSH_PULL = 0x20,
239 };
240
241 extern enum reset_types jtag_reset_config;
242
243 /* JTAG subsystem */
244 extern int jtag_init(struct command_context_s *cmd_ctx);
245 extern int jtag_register_commands(struct command_context_s *cmd_ctx);
246
247 /* JTAG interface, can be implemented with a software or hardware fifo */
248 extern int jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
249 extern int interface_jtag_add_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
250 extern int jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
251 extern int interface_jtag_add_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
252 extern int jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
253 extern int interface_jtag_add_plain_ir_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
254 extern int jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
255 extern int interface_jtag_add_plain_dr_scan(int num_fields, scan_field_t *fields, enum tap_state endstate);
256 /* execute a state transition within the JTAG standard, but the exact path
257 * path that is taken is undefined. Many implementations use precisely
258 * 7 clocks to perform a transition, but it could be more or less
259 * than that.
260 *
261 * The following assertions are made about certain common state moves:
262 *
263 * - A state move from Pause-[ID]R to Pause-[ID]R should always go through
264 * Update-[ID]R and Capture-[ID]R before returning to Pause-[ID]R, otherwise
265 * there's no way force a register update, if you can't go to Run-Test/Idle for
266 * some reason.
267 *
268 * - A state move from Pause-[ID]R to Shift-[ID]R must not go through
269 * Update-[ID]R.
270 *
271 * - Run-Test/Idle must not be entered unless requested, because R-T/I may have
272 * side effects.
273 */
274 extern int jtag_add_statemove(enum tap_state endstate);
275 extern int interface_jtag_add_statemove(enum tap_state endstate);
276 /* A list of unambigious single clock state transitions, not
277 * all drivers can support this, but it is required for e.g.
278 * XScale and Xilinx support
279 *
280 * Note! TAP_TLR must not be used in the path!
281 */
282 extern int jtag_add_pathmove(int num_states, enum tap_state *path);
283 extern int interface_jtag_add_pathmove(int num_states, enum tap_state *path);
284 /* cycle precisely num_cycles in the TAP_RTI state */
285 extern int jtag_add_runtest(int num_cycles, enum tap_state endstate);
286 extern int interface_jtag_add_runtest(int num_cycles, enum tap_state endstate);
287 extern int jtag_add_reset(int trst, int srst);
288 extern int interface_jtag_add_reset(int trst, int srst);
289 extern int jtag_add_end_state(enum tap_state endstate);
290 extern int interface_jtag_add_end_state(enum tap_state endstate);
291 extern int jtag_add_sleep(u32 us);
292 extern int interface_jtag_add_sleep(u32 us);
293
294
295
296 /*
297 * For software FIFO implementations, the queued commands can be executed
298 * during this call or earlier. A sw queue might decide to push out
299 * some of the jtag_add_xxx() operations once the queue is "big enough".
300 *
301 * This fn will return an error code if any of the prior jtag_add_xxx()
302 * calls caused a failure, e.g. check failure. Note that it does not
303 * matter if the operation was executed *before* jtag_execute_queue(),
304 * jtag_execute_queue() will still return an error code.
305 *
306 * All jtag_add_xxx() calls that have in_handler!=NULL will have been
307 * executed when this fn returns, but if what has been queued only
308 * clocks data out, without reading anything back, then JTAG could
309 * be running *after* jtag_execute_queue() returns. The API does
310 * not define a way to flush a hw FIFO that runs *after*
311 * jtag_execute_queue() returns.
312 *
313 * jtag_add_xxx() commands can either be executed immediately or
314 * at some time between the jtag_add_xxx() fn call and jtag_execute_queue().
315 */
316 extern int jtag_execute_queue(void);
317 /* can be implemented by hw+sw */
318 extern int interface_jtag_execute_queue(void);
319
320 /* JTAG support functions */
321 extern void jtag_set_check_value(scan_field_t *field, u8 *value, u8 *mask, error_handler_t *in_error_handler);
322 extern enum scan_type jtag_scan_type(scan_command_t *cmd);
323 extern int jtag_scan_size(scan_command_t *cmd);
324 extern int jtag_read_buffer(u8 *buffer, scan_command_t *cmd);
325 extern int jtag_build_buffer(scan_command_t *cmd, u8 **buffer);
326 extern jtag_device_t* jtag_get_device(int num);
327 extern void jtag_sleep(u32 us);
328 extern int jtag_call_event_callbacks(enum jtag_event event);
329 extern int jtag_register_event_callback(int (*callback)(enum jtag_event event, void *priv), void *priv);
330
331 extern int jtag_verify_capture_ir;
332
333
334 /* error codes
335 * JTAG subsystem uses codes between -100 and -199 */
336
337 #define ERROR_JTAG_INIT_FAILED (-100)
338 #define ERROR_JTAG_INVALID_INTERFACE (-101)
339 #define ERROR_JTAG_NOT_IMPLEMENTED (-102)
340 #define ERROR_JTAG_TRST_ASSERTED (-103)
341 #define ERROR_JTAG_QUEUE_FAILED (-104)
342 #define ERROR_JTAG_RESET_WOULD_ASSERT_TRST (-105)
343 #define ERROR_JTAG_RESET_CANT_SRST (-106)
344 #define ERROR_JTAG_DEVICE_ERROR (-107)
345
346
347
348 /* this allows JTAG devices to implement the entire jtag_xxx() layer in hw/sw */
349 #ifdef HAVE_JTAG_MINIDRIVER_H
350 /* Here a #define MINIDRIVER() and an inline version of hw fifo interface_jtag_add_dr_out can be defined */
351 #include "jtag_minidriver.h"
352 #define MINIDRIVER(a) notused ## a
353 #else
354 #define MINIDRIVER(a) a
355 /* jtag_add_dr_out() is a faster version of jtag_add_dr_scan()
356 *
357 * Current or end_state can not be TAP_TLR. end_state can be -1
358 *
359 * num_bits[i] is the number of bits to clock out from value[i] LSB first.
360 *
361 * If the device is in bypass, then that is an error condition in
362 * the caller code that is not detected by this fn, whereas jtag_add_dr_scan()
363 * does detect it. Similarly if the device is not in bypass, data must
364 * be passed to it.
365 *
366 * If anything fails, then jtag_error will be set and jtag_execute() will
367 * return an error. There is no way to determine if there was a failure
368 * during this function call.
369 *
370 * Note that this jtag_add_dr_out can be defined as an inline function.
371 */
372 extern void interface_jtag_add_dr_out(int device,
373 int num_fields,
374 int *num_bits,
375 u32 *value,
376 enum tap_state end_state);
377 #endif
378
379
380
381
382 static __inline__ void jtag_add_dr_out(int device,
383 int num_fields,
384 int *num_bits,
385 u32 *value,
386 enum tap_state end_state)
387 {
388 if (end_state != -1)
389 cmd_queue_end_state=end_state;
390 cmd_queue_cur_state=cmd_queue_end_state;
391 interface_jtag_add_dr_out(device, num_fields, num_bits, value, cmd_queue_end_state);
392 }
393
394
395 #endif /* JTAG_H */