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 ***************************************************************************/
32 #include <sys/types.h>
40 #define XSTATE_MAX_PATH (12)
42 int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
46 u8 *dr_out_buf; /* from host to device (TDI) */
47 u8 *dr_in_buf; /* from device to host (TDO) */
51 int xruntest = 0; /* number of TCK cycles / microseconds */
52 int xrepeat = 0x20; /* number of XC9500 retries */
57 enum tap_state xsvf_to_tap[] =
60 TAP_SDS, TAP_CD, TAP_SD, TAP_E1D, TAP_PD, TAP_E2D, TAP_UD,
61 TAP_SIS, TAP_CI, TAP_SI, TAP_E1I, TAP_PI, TAP_E2I, TAP_UI,
66 0x0, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8, 0x1, 0x9, 0xa, 0xb, 0xc, 0xe, 0xf
70 /* xsvf has it's own definition of a statemove. This needs
71 * to be handled according to the specs, which has nothing
72 * to do with the JTAG spec or OpenOCD as such.
74 * Implemented via jtag_add_pathmove().
76 void xsvf_add_statemove(enum tap_state state)
78 enum tap_state moves[7]; /* max # of transitions */
80 enum tap_state curstate = cmd_queue_cur_state;
81 u8 move = TAP_MOVE(cmd_queue_cur_state, state);
83 if ((state != TAP_TLR) && (state == cmd_queue_cur_state))
88 int j = (move >> i) & 1;
91 curstate = tap_transitions[curstate].high;
94 curstate = tap_transitions[curstate].low;
99 jtag_add_pathmove(7, moves);
102 int xsvf_register_commands(struct command_context_s *cmd_ctx)
104 register_command(cmd_ctx, NULL, "xsvf", handle_xsvf_command,
105 COMMAND_EXEC, "run xsvf <file>");
110 int xsvf_read_buffer(int num_bits, int fd, u8* buf)
114 for (num_bytes = (num_bits + 7) / 8; num_bytes > 0; num_bytes--)
116 if (read(fd, buf + num_bytes - 1, 1) < 0)
117 return ERROR_XSVF_EOF;
123 int xsvf_read_xstates(int fd, enum tap_state *path, int max_path, int *path_len)
128 while ((read(fd, &c, 1) > 0) && (c == 0x12))
130 if (*path_len > max_path)
132 LOG_WARNING("XSTATE path longer than max_path");
135 if (read(fd, &uc, 1) < 0)
137 return ERROR_XSVF_EOF;
139 path[(*path_len)++] = xsvf_to_tap[uc];
142 lseek(fd, -1, SEEK_CUR);
147 int handle_xsvf_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
151 unsigned char uc, uc2;
157 int tdo_mismatch = 0;
159 int runtest_requires_tck = 0;
161 int device = -1; /* use -1 to indicate a "plain" xsvf file which accounts for additional devices in the scan chain, otherwise the device that should be affected */
165 command_print(cmd_ctx, "usage: xsvf <device#|plain> <file> <variant>");
169 if (strcmp(args[0], "plain") != 0)
171 device = strtoul(args[0], NULL, 0);
174 if ((xsvf_fd = open(args[1], O_RDONLY)) < 0)
176 command_print(cmd_ctx, "file %s not found", args[0]);
180 if ((argc > 2) && (strcmp(args[2], "virt2") == 0))
182 runtest_requires_tck = 1;
185 while (read(xsvf_fd, &c, 1) > 0)
189 case 0x00: /* XCOMPLETE */
190 LOG_DEBUG("XCOMPLETE");
191 if (jtag_execute_queue() != ERROR_OK)
197 case 0x01: /* XTDOMASK */
198 LOG_DEBUG("XTDOMASK");
199 if (dr_in_mask && (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_mask) != ERROR_OK))
202 case 0x02: /* XSIR */
204 if (read(xsvf_fd, &c, 1) < 0)
208 u8 *ir_buf = malloc((c + 7) / 8);
209 if (xsvf_read_buffer(c, xsvf_fd, ir_buf) != ERROR_OK)
214 field.device = device;
216 field.out_value = ir_buf;
217 field.out_mask = NULL;
218 field.in_value = NULL;
219 field.in_check_value = NULL;
220 field.in_check_mask = NULL;
221 field.in_handler = NULL;
222 field.in_handler_priv = NULL;
224 jtag_add_plain_ir_scan(1, &field, TAP_PI);
226 jtag_add_ir_scan(1, &field, TAP_PI);
227 if (jtag_execute_queue() != ERROR_OK)
235 if (runtest_requires_tck)
236 jtag_add_runtest(xruntest, xsvf_to_tap[xendir]);
239 xsvf_add_statemove(TAP_RTI);
240 jtag_add_sleep(xruntest);
241 xsvf_add_statemove(xsvf_to_tap[xendir]);
244 else if (xendir != 0xd) /* Pause-IR */
245 xsvf_add_statemove(xsvf_to_tap[xendir]);
250 case 0x03: /* XSDR */
252 if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK)
257 field.device = device;
258 field.num_bits = xsdrsize;
259 field.out_value = dr_out_buf;
260 field.out_mask = NULL;
261 field.in_value = NULL;
262 jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL);
264 jtag_add_plain_dr_scan(1, &field, TAP_PD);
266 jtag_add_dr_scan(1, &field, TAP_PD);
267 if (jtag_execute_queue() != ERROR_OK)
274 if (runtest_requires_tck)
275 jtag_add_runtest(xruntest, xsvf_to_tap[xenddr]);
278 xsvf_add_statemove(TAP_RTI);
279 jtag_add_sleep(xruntest);
280 xsvf_add_statemove(xsvf_to_tap[xenddr]);
283 else if (xendir != 0x6) /* Pause-DR */
284 xsvf_add_statemove(xsvf_to_tap[xenddr]);
287 case 0x04: /* XRUNTEST */
288 LOG_DEBUG("XRUNTEST");
289 if (read(xsvf_fd, buf4, 4) < 0)
293 xruntest = be_to_h_u32(buf4);
296 case 0x07: /* XREPEAT */
297 LOG_DEBUG("XREPEAT");
298 if (read(xsvf_fd, &c, 1) < 0)
305 case 0x08: /* XSDRSIZE */
306 LOG_DEBUG("XSDRSIZE");
307 if (read(xsvf_fd, buf4, 4) < 0)
311 xsdrsize = be_to_h_u32(buf4);
315 dr_out_buf = malloc((xsdrsize + 7) / 8);
316 dr_in_buf = malloc((xsdrsize + 7) / 8);
317 dr_in_mask = malloc((xsdrsize + 7) / 8);
320 case 0x09: /* XSDRTDO */
321 LOG_DEBUG("XSDRTDO");
322 if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_out_buf) != ERROR_OK)
326 if (xsvf_read_buffer(xsdrsize, xsvf_fd, dr_in_buf) != ERROR_OK)
331 field.device = device;
332 field.num_bits = xsdrsize;
333 field.out_value = dr_out_buf;
334 field.out_mask = NULL;
335 field.in_value = NULL;
336 jtag_set_check_value(&field, dr_in_buf, dr_in_mask, NULL);
338 jtag_add_plain_dr_scan(1, &field, TAP_PD);
340 jtag_add_dr_scan(1, &field, TAP_PD);
341 if (jtag_execute_queue() != ERROR_OK)
348 if (runtest_requires_tck)
349 jtag_add_runtest(xruntest, xsvf_to_tap[xenddr]);
352 xsvf_add_statemove(TAP_RTI);
353 jtag_add_sleep(xruntest);
354 xsvf_add_statemove(xsvf_to_tap[xenddr]);
357 else if (xendir != 0x6) /* Pause-DR */
358 xsvf_add_statemove(xsvf_to_tap[xenddr]);
362 case 0x0a: /* XSETDRMASKS */
363 LOG_ERROR("unsupported XSETSDRMASKS\n");
366 case 0x0b: /* XSDRINC */
367 LOG_ERROR("unsupported XSDRINC\n");
370 case 0x0c: /* XSDRB */
373 case 0x0d: /* XSDRC */
376 case 0x0e: /* XSDRE */
379 case 0x0f: /* XSDRTDOB */
382 case 0x10: /* XSDRTDOB */
385 case 0x11: /* XSDRTDOB */
388 case 0x12: /* XSTATE */
390 if (read(xsvf_fd, &uc, 1) < 0)
394 enum tap_state *path = calloc(XSTATE_MAX_PATH, 4);
396 path[0] = xsvf_to_tap[uc];
397 if (xsvf_read_xstates(xsvf_fd, path, XSTATE_MAX_PATH, &path_len) != ERROR_OK)
401 jtag_add_pathmove(path_len, path);
406 case 0x13: /* XENDIR */
408 if (read(xsvf_fd, &c, 1) < 0)
418 LOG_ERROR("unknown XENDIR endstate");
423 case 0x14: /* XENDDR */
425 if (read(xsvf_fd, &c, 1) < 0)
435 LOG_ERROR("unknown XENDDR endstate");
440 case 0x15: /* XSIR2 */
442 if (read(xsvf_fd, buf2, 2) < 0)
447 us = be_to_h_u16(buf2);
448 ir_buf = malloc((us + 7) / 8);
449 if (xsvf_read_buffer(us, xsvf_fd, ir_buf) != ERROR_OK)
454 field.device = device;
456 field.out_value = ir_buf;
457 field.out_mask = NULL;
458 field.in_value = NULL;
459 field.in_check_value = NULL;
460 field.in_check_mask = NULL;
461 field.in_handler = NULL;
462 field.in_handler_priv = NULL;
464 jtag_add_plain_ir_scan(1, &field, xsvf_to_tap[xendir]);
466 jtag_add_ir_scan(1, &field, xsvf_to_tap[xendir]);
471 case 0x16: /* XCOMMENT */
474 if (read(xsvf_fd, &c, 1) < 0)
481 case 0x17: /* XWAIT */
483 if ((read(xsvf_fd, &uc, 1) < 0) || (read(xsvf_fd, &uc2, 1) < 0) || (read(xsvf_fd, buf4, 4) < 0))
487 xsvf_add_statemove(xsvf_to_tap[uc]);
488 ui = be_to_h_u32(buf4);
490 xsvf_add_statemove(xsvf_to_tap[uc2]);
494 LOG_ERROR("unknown xsvf command (0x%2.2x)\n", c);
498 if (do_abort || unsupported || tdo_mismatch)
504 command_print(cmd_ctx, "TDO mismatch, aborting");
510 command_print(cmd_ctx, "unsupported xsvf command encountered, aborting");
516 command_print(cmd_ctx, "premature end detected, aborting");
531 command_print(cmd_ctx, "XSVF file programmed successfully");