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, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
19 ***************************************************************************/
22 * This file is based on Dominic Rath's amt_jtagaccel.c.
24 * usbprog is a free programming adapter. You can easily install
25 * different firmware versions from an "online pool" over USB.
26 * The adapter can be used for programming and debugging AVR and ARM
27 * processors, as USB to RS232 converter, as JTAG interface or as
28 * simple I/O interface (5 lines).
30 * http://www.embedded-projects.net/usbprog
37 #include <jtag/interface.h>
38 #include <jtag/commands.h>
39 #include "usb_common.h"
50 static void usbprog_end_state(tap_state_t state);
51 static void usbprog_state_move(void);
52 static void usbprog_path_move(struct pathmove_command *cmd);
53 static void usbprog_runtest(int num_cycles);
54 static void usbprog_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size);
56 #define UNKNOWN_COMMAND 0x00
57 #define PORT_DIRECTION 0x01
60 #define PORT_SETBIT 0x04
61 #define PORT_GETBIT 0x05
62 #define WRITE_TDI 0x06
64 #define WRITE_AND_READ 0x08
65 #define WRITE_TMS 0x09
66 #define WRITE_TMS_CHAIN 0x0A
69 struct usb_dev_handle *usb_handle;
72 static struct usbprog_jtag *usbprog_jtag_handle;
74 static struct usbprog_jtag *usbprog_jtag_open(void);
75 /* static void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag); */
76 static void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag);
77 static unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen);
79 static void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char *buffer, int size);
80 static void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char *buffer, int size);
81 static void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char *buffer, int size);
82 static void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan);
84 static char tms_chain[64];
85 static int tms_chain_index;
87 static void usbprog_jtag_tms_collect(char tms_scan);
88 static void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag);
90 static void usbprog_write(int tck, int tms, int tdi);
91 static void usbprog_reset(int trst, int srst);
93 static void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction);
94 static void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag, unsigned char value);
95 /* static unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag); */
96 static void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag, int bit, int value);
97 /* static int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit); */
99 static int usbprog_execute_queue(void)
101 struct jtag_command *cmd = jtag_command_queue; /* currently processed command */
109 #ifdef _DEBUG_JTAG_IO_
110 LOG_DEBUG("reset trst: %i srst %i",
111 cmd->cmd.reset->trst,
112 cmd->cmd.reset->srst);
114 if (cmd->cmd.reset->trst == 1)
115 tap_set_state(TAP_RESET);
116 usbprog_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
119 #ifdef _DEBUG_JTAG_IO_
120 LOG_DEBUG("runtest %i cycles, end in %i",
121 cmd->cmd.runtest->num_cycles,
122 cmd->cmd.runtest->end_state);
124 usbprog_end_state(cmd->cmd.runtest->end_state);
125 usbprog_runtest(cmd->cmd.runtest->num_cycles);
128 #ifdef _DEBUG_JTAG_IO_
129 LOG_DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
131 usbprog_end_state(cmd->cmd.statemove->end_state);
132 usbprog_state_move();
135 #ifdef _DEBUG_JTAG_IO_
136 LOG_DEBUG("pathmove: %i states, end in %i",
137 cmd->cmd.pathmove->num_states,
138 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
140 usbprog_path_move(cmd->cmd.pathmove);
143 #ifdef _DEBUG_JTAG_IO_
144 LOG_DEBUG("scan end in %i", cmd->cmd.scan->end_state);
146 usbprog_end_state(cmd->cmd.scan->end_state);
147 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
148 type = jtag_scan_type(cmd->cmd.scan);
149 usbprog_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size);
150 if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
151 return ERROR_JTAG_QUEUE_FAILED;
156 #ifdef _DEBUG_JTAG_IO_
157 LOG_DEBUG("sleep %i", cmd->cmd.sleep->us);
159 jtag_sleep(cmd->cmd.sleep->us);
162 LOG_ERROR("BUG: unknown JTAG command type encountered");
172 static int usbprog_init(void)
174 usbprog_jtag_handle = usbprog_jtag_open();
177 if (usbprog_jtag_handle == 0) {
178 LOG_ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
179 return ERROR_JTAG_INIT_FAILED;
182 LOG_INFO("USB JTAG Interface ready!");
184 usbprog_jtag_init(usbprog_jtag_handle);
186 usbprog_write(0, 0, 0);
191 static int usbprog_quit(void)
196 /*************** jtag execute commands **********************/
197 static void usbprog_end_state(tap_state_t state)
199 if (tap_is_state_stable(state))
200 tap_set_end_state(state);
202 LOG_ERROR("BUG: %i is not a valid end state", state);
207 static void usbprog_state_move(void)
209 uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
211 usbprog_jtag_write_tms(usbprog_jtag_handle, (char)tms_scan);
213 tap_set_state(tap_get_end_state());
216 static void usbprog_path_move(struct pathmove_command *cmd)
218 int num_states = cmd->num_states;
221 /* There may be queued transitions, and before following a specified
222 path, we must flush those queued transitions */
223 usbprog_jtag_tms_send(usbprog_jtag_handle);
227 if (tap_state_transition(tap_get_state(), false) == cmd->path[state_count]) {
229 usbprog_write(0, 0, 0);
230 usbprog_write(1, 0, 0);
231 } else if (tap_state_transition(tap_get_state(),
232 true) == cmd->path[state_count]) {
234 usbprog_write(0, 1, 0);
235 usbprog_write(1, 1, 0);
237 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
238 tap_state_name(tap_get_state()),
239 tap_state_name(cmd->path[state_count]));
243 tap_set_state(cmd->path[state_count]);
248 tap_set_end_state(tap_get_state());
251 static void usbprog_runtest(int num_cycles)
255 /* only do a state_move when we're not already in IDLE */
256 if (tap_get_state() != TAP_IDLE) {
257 usbprog_end_state(TAP_IDLE);
258 usbprog_state_move();
261 /* execute num_cycles */
262 if (num_cycles > 0) {
263 usbprog_jtag_tms_send(usbprog_jtag_handle);
264 usbprog_write(0, 0, 0);
266 usbprog_jtag_tms_send(usbprog_jtag_handle);
267 /* LOG_INFO("NUM CYCLES %i",num_cycles); */
270 for (i = 0; i < num_cycles; i++) {
271 usbprog_write(1, 0, 0);
272 usbprog_write(0, 0, 0);
275 #ifdef _DEBUG_JTAG_IO_
276 LOG_DEBUG("runtest: cur_state %s end_state %s", tap_state_name(
277 tap_get_state()), tap_state_name(tap_get_end_state()));
280 /* finish in end_state */
282 usbprog_end_state(saved_end_state);
283 if (tap_get_state() != tap_get_end_state())
284 usbprog_state_move();
288 static void usbprog_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size)
290 tap_state_t saved_end_state = tap_get_end_state();
293 usbprog_end_state(TAP_IRSHIFT);
295 usbprog_end_state(TAP_DRSHIFT);
297 /* Only move if we're not already there */
298 if (tap_get_state() != tap_get_end_state())
299 usbprog_state_move();
301 usbprog_end_state(saved_end_state);
303 usbprog_jtag_tms_send(usbprog_jtag_handle);
305 void (*f)(struct usbprog_jtag *usbprog_jtag, char *buffer_local, int size);
308 f = &usbprog_jtag_write_tdi;
311 f = &usbprog_jtag_read_tdo;
314 f = &usbprog_jtag_write_and_read;
317 LOG_ERROR("unknown scan type: %i", type);
320 f(usbprog_jtag_handle, (char *)buffer, scan_size);
322 /* The adapter does the transition to PAUSE internally */
324 tap_set_state(TAP_IRPAUSE);
326 tap_set_state(TAP_DRPAUSE);
328 if (tap_get_state() != tap_get_end_state())
329 usbprog_state_move();
332 /*************** jtag wrapper functions *********************/
334 static void usbprog_write(int tck, int tms, int tdi)
336 unsigned char output_value = 0x00;
339 output_value |= (1 << TMS_BIT);
341 output_value |= (1 << TDI_BIT);
343 output_value |= (1 << TCK_BIT);
345 usbprog_jtag_write_slice(usbprog_jtag_handle, output_value);
348 /* (1) assert or (0) deassert reset lines */
349 static void usbprog_reset(int trst, int srst)
351 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
354 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 0);
356 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 1);
359 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 0);
361 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 1);
364 /*************** jtag lowlevel functions ********************/
366 struct usb_bus *busses;
368 struct usbprog_jtag *usbprog_jtag_open(void)
373 const uint16_t vids[] = { VID, 0 };
374 const uint16_t pids[] = { PID, 0 };
375 struct usb_dev_handle *dev;
376 if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
379 struct usbprog_jtag *tmp = malloc(sizeof(struct usbprog_jtag));
380 tmp->usb_handle = dev;
382 usb_set_configuration(dev, 1);
383 usb_claim_interface(dev, 0);
384 usb_set_altinterface(dev, 0);
390 static void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag)
392 usb_close(usbprog_jtag->usb_handle);
397 static unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen)
399 int res = usb_bulk_write(usbprog_jtag->usb_handle, 3, msg, msglen, 100);
400 if ((msg[0] == 2) || (msg[0] == 1) || (msg[0] == 4) || (msg[0] == 0) || \
401 (msg[0] == 6) || (msg[0] == 0x0A) || (msg[0] == 9))
404 /* LOG_INFO("HALLLLOOO %i",(int)msg[0]); */
405 res = usb_bulk_read(usbprog_jtag->usb_handle, 0x82, msg, 2, 100);
407 return (unsigned char)msg[1];
415 static void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag)
417 usbprog_jtag_set_direction(usbprog_jtag, 0xFE);
420 static void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char *buffer, int size)
422 char tmp[64]; /* fastes packet size for usb controller */
423 int send_bits, bufindex = 0, fillindex = 0, i, loops;
426 /* 61 byte can be transfered (488 bit) */
439 tmp[0] = WRITE_AND_READ;
440 tmp[1] = (char)(send_bits >> 8); /* high */
441 tmp[2] = (char)(send_bits); /* low */
443 for (i = 0; i < loops; i++) {
444 tmp[3 + i] = buffer[bufindex];
448 if (usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000) == 64) {
449 /* LOG_INFO("HALLLLOOO2 %i",(int)tmp[0]); */
452 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 1000) < 1) {
458 for (i = 0; i < loops; i++) {
460 buffer[fillindex++] = swap;
466 static void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char *buffer, int size)
468 char tmp[64]; /* fastes packet size for usb controller */
469 int send_bits, fillindex = 0, i, loops;
472 /* 61 byte can be transfered (488 bit) */
485 tmp[0] = WRITE_AND_READ;
486 tmp[1] = (char)(send_bits >> 8); /* high */
487 tmp[2] = (char)(send_bits); /* low */
489 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 3, 1000);
491 /* LOG_INFO("HALLLLOOO3 %i",(int)tmp[0]); */
494 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 10) < 1) {
500 for (i = 0; i < loops; i++) {
502 buffer[fillindex++] = swap;
507 static void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char *buffer, int size)
509 char tmp[64]; /* fastes packet size for usb controller */
510 int send_bits, bufindex = 0, i, loops;
512 /* 61 byte can be transfered (488 bit) */
521 /* if (loops == 0) */
526 tmp[1] = (char)(send_bits >> 8); /* high */
527 tmp[2] = (char)(send_bits); /* low */
529 for (i = 0; i < loops; i++) {
530 tmp[3 + i] = buffer[bufindex];
533 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000);
537 static void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan)
539 usbprog_jtag_tms_collect(tms_scan);
542 static void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction)
545 tmp[0] = PORT_DIRECTION;
546 tmp[1] = (char)direction;
547 usbprog_jtag_message(usbprog_jtag, tmp, 2);
550 static void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag, unsigned char value)
554 tmp[1] = (char)value;
555 usbprog_jtag_message(usbprog_jtag, tmp, 2);
559 static unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag)
564 return usbprog_jtag_message(usbprog_jtag, tmp, 2);
568 static void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag, int bit, int value)
571 tmp[0] = PORT_SETBIT;
577 usbprog_jtag_message(usbprog_jtag, tmp, 3);
581 static int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit)
584 tmp[0] = PORT_GETBIT;
587 if (usbprog_jtag_message(usbprog_jtag, tmp, 2) > 0)
594 static void usbprog_jtag_tms_collect(char tms_scan)
596 tms_chain[tms_chain_index] = tms_scan;
600 static void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag)
603 /* LOG_INFO("TMS SEND"); */
604 if (tms_chain_index > 0) {
605 char tmp[tms_chain_index + 2];
606 tmp[0] = WRITE_TMS_CHAIN;
607 tmp[1] = (char)(tms_chain_index);
608 for (i = 0; i < tms_chain_index + 1; i++)
609 tmp[2 + i] = tms_chain[i];
610 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, tms_chain_index + 2, 1000);
615 struct jtag_interface usbprog_interface = {
618 .execute_queue = usbprog_execute_queue,
619 .init = usbprog_init,