1 /***************************************************************************
2 * Copyright (C) 2007 by Benedikt Sauter *
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, see <http://www.gnu.org/licenses/>. *
17 ***************************************************************************/
20 * This file is based on Dominic Rath's amt_jtagaccel.c.
22 * usbprog is a free programming adapter. You can easily install
23 * different firmware versions from an "online pool" over USB.
24 * The adapter can be used for programming and debugging AVR and ARM
25 * processors, as USB to RS232 converter, as JTAG interface or as
26 * simple I/O interface (5 lines).
28 * http://www.embedded-projects.net/usbprog
35 #include <jtag/interface.h>
36 #include <jtag/commands.h>
37 #include "usb_common.h"
48 static void usbprog_end_state(tap_state_t state);
49 static void usbprog_state_move(void);
50 static void usbprog_path_move(struct pathmove_command *cmd);
51 static void usbprog_runtest(int num_cycles);
52 static void usbprog_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size);
54 #define UNKNOWN_COMMAND 0x00
55 #define PORT_DIRECTION 0x01
58 #define PORT_SETBIT 0x04
59 #define PORT_GETBIT 0x05
60 #define WRITE_TDI 0x06
62 #define WRITE_AND_READ 0x08
63 #define WRITE_TMS 0x09
64 #define WRITE_TMS_CHAIN 0x0A
67 struct usb_dev_handle *usb_handle;
70 static struct usbprog_jtag *usbprog_jtag_handle;
72 static struct usbprog_jtag *usbprog_jtag_open(void);
73 /* static void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag); */
74 static void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag);
75 static unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen);
77 static void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char *buffer, int size);
78 static void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char *buffer, int size);
79 static void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char *buffer, int size);
80 static void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan);
82 static char tms_chain[64];
83 static int tms_chain_index;
85 static void usbprog_jtag_tms_collect(char tms_scan);
86 static void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag);
88 static void usbprog_write(int tck, int tms, int tdi);
89 static void usbprog_reset(int trst, int srst);
91 static void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction);
92 static void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag, unsigned char value);
93 /* static unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag); */
94 static void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag, int bit, int value);
95 /* static int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit); */
97 static int usbprog_execute_queue(void)
99 struct jtag_command *cmd = jtag_command_queue; /* currently processed command */
107 #ifdef _DEBUG_JTAG_IO_
108 LOG_DEBUG("reset trst: %i srst %i",
109 cmd->cmd.reset->trst,
110 cmd->cmd.reset->srst);
112 if (cmd->cmd.reset->trst == 1)
113 tap_set_state(TAP_RESET);
114 usbprog_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
117 #ifdef _DEBUG_JTAG_IO_
118 LOG_DEBUG("runtest %i cycles, end in %i",
119 cmd->cmd.runtest->num_cycles,
120 cmd->cmd.runtest->end_state);
122 usbprog_end_state(cmd->cmd.runtest->end_state);
123 usbprog_runtest(cmd->cmd.runtest->num_cycles);
126 #ifdef _DEBUG_JTAG_IO_
127 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
129 usbprog_end_state(cmd->cmd.statemove->end_state);
130 usbprog_state_move();
133 #ifdef _DEBUG_JTAG_IO_
134 LOG_DEBUG("pathmove: %i states, end in %i",
135 cmd->cmd.pathmove->num_states,
136 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
138 usbprog_path_move(cmd->cmd.pathmove);
141 #ifdef _DEBUG_JTAG_IO_
142 LOG_DEBUG("scan end in %i", cmd->cmd.scan->end_state);
144 usbprog_end_state(cmd->cmd.scan->end_state);
145 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
146 type = jtag_scan_type(cmd->cmd.scan);
147 usbprog_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size);
148 if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
149 return ERROR_JTAG_QUEUE_FAILED;
154 #ifdef _DEBUG_JTAG_IO_
155 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
157 jtag_sleep(cmd->cmd.sleep->us);
160 LOG_ERROR("BUG: unknown JTAG command type encountered");
170 static int usbprog_init(void)
172 usbprog_jtag_handle = usbprog_jtag_open();
175 if (usbprog_jtag_handle == 0) {
176 LOG_ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
177 return ERROR_JTAG_INIT_FAILED;
180 LOG_INFO("USB JTAG Interface ready!");
182 usbprog_jtag_init(usbprog_jtag_handle);
184 usbprog_write(0, 0, 0);
189 static int usbprog_quit(void)
194 /*************** jtag execute commands **********************/
195 static void usbprog_end_state(tap_state_t state)
197 if (tap_is_state_stable(state))
198 tap_set_end_state(state);
200 LOG_ERROR("BUG: %i is not a valid end state", state);
205 static void usbprog_state_move(void)
207 uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
209 usbprog_jtag_write_tms(usbprog_jtag_handle, (char)tms_scan);
211 tap_set_state(tap_get_end_state());
214 static void usbprog_path_move(struct pathmove_command *cmd)
216 int num_states = cmd->num_states;
219 /* There may be queued transitions, and before following a specified
220 path, we must flush those queued transitions */
221 usbprog_jtag_tms_send(usbprog_jtag_handle);
225 if (tap_state_transition(tap_get_state(), false) == cmd->path[state_count]) {
227 usbprog_write(0, 0, 0);
228 usbprog_write(1, 0, 0);
229 } else if (tap_state_transition(tap_get_state(),
230 true) == cmd->path[state_count]) {
232 usbprog_write(0, 1, 0);
233 usbprog_write(1, 1, 0);
235 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
236 tap_state_name(tap_get_state()),
237 tap_state_name(cmd->path[state_count]));
241 tap_set_state(cmd->path[state_count]);
246 tap_set_end_state(tap_get_state());
249 static void usbprog_runtest(int num_cycles)
253 /* only do a state_move when we're not already in IDLE */
254 if (tap_get_state() != TAP_IDLE) {
255 usbprog_end_state(TAP_IDLE);
256 usbprog_state_move();
259 /* execute num_cycles */
260 if (num_cycles > 0) {
261 usbprog_jtag_tms_send(usbprog_jtag_handle);
262 usbprog_write(0, 0, 0);
264 usbprog_jtag_tms_send(usbprog_jtag_handle);
265 /* LOG_INFO("NUM CYCLES %i",num_cycles); */
268 for (i = 0; i < num_cycles; i++) {
269 usbprog_write(1, 0, 0);
270 usbprog_write(0, 0, 0);
273 #ifdef _DEBUG_JTAG_IO_
274 LOG_DEBUG("runtest: cur_state %s end_state %s", tap_state_name(
275 tap_get_state()), tap_state_name(tap_get_end_state()));
278 /* finish in end_state */
280 usbprog_end_state(saved_end_state);
281 if (tap_get_state() != tap_get_end_state())
282 usbprog_state_move();
286 static void usbprog_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size)
288 tap_state_t saved_end_state = tap_get_end_state();
291 usbprog_end_state(TAP_IRSHIFT);
293 usbprog_end_state(TAP_DRSHIFT);
295 /* Only move if we're not already there */
296 if (tap_get_state() != tap_get_end_state())
297 usbprog_state_move();
299 usbprog_end_state(saved_end_state);
301 usbprog_jtag_tms_send(usbprog_jtag_handle);
303 void (*f)(struct usbprog_jtag *usbprog_jtag, char *buffer_local, int size);
306 f = &usbprog_jtag_write_tdi;
309 f = &usbprog_jtag_read_tdo;
312 f = &usbprog_jtag_write_and_read;
315 LOG_ERROR("unknown scan type: %i", type);
318 f(usbprog_jtag_handle, (char *)buffer, scan_size);
320 /* The adapter does the transition to PAUSE internally */
322 tap_set_state(TAP_IRPAUSE);
324 tap_set_state(TAP_DRPAUSE);
326 if (tap_get_state() != tap_get_end_state())
327 usbprog_state_move();
330 /*************** jtag wrapper functions *********************/
332 static void usbprog_write(int tck, int tms, int tdi)
334 unsigned char output_value = 0x00;
337 output_value |= (1 << TMS_BIT);
339 output_value |= (1 << TDI_BIT);
341 output_value |= (1 << TCK_BIT);
343 usbprog_jtag_write_slice(usbprog_jtag_handle, output_value);
346 /* (1) assert or (0) deassert reset lines */
347 static void usbprog_reset(int trst, int srst)
349 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
352 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 0);
354 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 1);
357 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 0);
359 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 1);
362 /*************** jtag lowlevel functions ********************/
364 struct usb_bus *busses;
366 struct usbprog_jtag *usbprog_jtag_open(void)
371 const uint16_t vids[] = { VID, 0 };
372 const uint16_t pids[] = { PID, 0 };
373 struct usb_dev_handle *dev;
374 if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
377 struct usbprog_jtag *tmp = malloc(sizeof(struct usbprog_jtag));
378 tmp->usb_handle = dev;
380 usb_set_configuration(dev, 1);
381 usb_claim_interface(dev, 0);
382 usb_set_altinterface(dev, 0);
388 static void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag)
390 usb_close(usbprog_jtag->usb_handle);
395 static unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen)
397 int res = usb_bulk_write(usbprog_jtag->usb_handle, 3, msg, msglen, 100);
398 if ((msg[0] == 2) || (msg[0] == 1) || (msg[0] == 4) || (msg[0] == 0) || \
399 (msg[0] == 6) || (msg[0] == 0x0A) || (msg[0] == 9))
402 /* LOG_INFO("HALLLLOOO %i",(int)msg[0]); */
403 res = usb_bulk_read(usbprog_jtag->usb_handle, 0x82, msg, 2, 100);
405 return (unsigned char)msg[1];
413 static void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag)
415 usbprog_jtag_set_direction(usbprog_jtag, 0xFE);
418 static void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char *buffer, int size)
420 char tmp[64]; /* fastes packet size for usb controller */
421 int send_bits, bufindex = 0, fillindex = 0, i, loops;
424 /* 61 byte can be transfered (488 bit) */
437 tmp[0] = WRITE_AND_READ;
438 tmp[1] = (char)(send_bits >> 8); /* high */
439 tmp[2] = (char)(send_bits); /* low */
441 for (i = 0; i < loops; i++) {
442 tmp[3 + i] = buffer[bufindex];
446 if (usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000) == 64) {
447 /* LOG_INFO("HALLLLOOO2 %i",(int)tmp[0]); */
450 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 1000) < 1) {
456 for (i = 0; i < loops; i++) {
458 buffer[fillindex++] = swap;
464 static void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char *buffer, int size)
466 char tmp[64]; /* fastes packet size for usb controller */
467 int send_bits, fillindex = 0, i, loops;
470 /* 61 byte can be transfered (488 bit) */
483 tmp[0] = WRITE_AND_READ;
484 tmp[1] = (char)(send_bits >> 8); /* high */
485 tmp[2] = (char)(send_bits); /* low */
487 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 3, 1000);
489 /* LOG_INFO("HALLLLOOO3 %i",(int)tmp[0]); */
492 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 10) < 1) {
498 for (i = 0; i < loops; i++) {
500 buffer[fillindex++] = swap;
505 static void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char *buffer, int size)
507 char tmp[64]; /* fastes packet size for usb controller */
508 int send_bits, bufindex = 0, i, loops;
510 /* 61 byte can be transfered (488 bit) */
519 /* if (loops == 0) */
524 tmp[1] = (char)(send_bits >> 8); /* high */
525 tmp[2] = (char)(send_bits); /* low */
527 for (i = 0; i < loops; i++) {
528 tmp[3 + i] = buffer[bufindex];
531 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000);
535 static void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan)
537 usbprog_jtag_tms_collect(tms_scan);
540 static void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction)
543 tmp[0] = PORT_DIRECTION;
544 tmp[1] = (char)direction;
545 usbprog_jtag_message(usbprog_jtag, tmp, 2);
548 static void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag, unsigned char value)
552 tmp[1] = (char)value;
553 usbprog_jtag_message(usbprog_jtag, tmp, 2);
557 static unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag)
562 return usbprog_jtag_message(usbprog_jtag, tmp, 2);
566 static void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag, int bit, int value)
569 tmp[0] = PORT_SETBIT;
575 usbprog_jtag_message(usbprog_jtag, tmp, 3);
579 static int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit)
582 tmp[0] = PORT_GETBIT;
585 if (usbprog_jtag_message(usbprog_jtag, tmp, 2) > 0)
592 static void usbprog_jtag_tms_collect(char tms_scan)
594 tms_chain[tms_chain_index] = tms_scan;
598 static void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag)
601 /* LOG_INFO("TMS SEND"); */
602 if (tms_chain_index > 0) {
603 char tmp[tms_chain_index + 2];
604 tmp[0] = WRITE_TMS_CHAIN;
605 tmp[1] = (char)(tms_chain_index);
606 for (i = 0; i < tms_chain_index + 1; i++)
607 tmp[2 + i] = tms_chain[i];
608 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, tms_chain_index + 2, 1000);
613 struct jtag_interface usbprog_interface = {
616 .execute_queue = usbprog_execute_queue,
617 .init = usbprog_init,