1 /***************************************************************************
2 * Copyright (C) 2007 by Benedikt Sauter sauter@ixbat.de *
3 * based on Dominic Rath's amt_jtagaccel.c *
5 * usbprog is a free programming adapter. You can easily install *
6 * different firmware versions from an "online pool" over USB. *
7 * The adapter can be used for programming and debugging AVR and ARM *
8 * processors, as USB to RS232 converter, as JTAG interface or as *
9 * simple I/O interface (5 lines). *
11 * http://www.embedded-projects.net/usbprog *
13 * This program is free software; you can redistribute it and/or modify *
14 * it under the terms of the GNU General Public License as published by *
15 * the Free Software Foundation; either version 2 of the License, or *
16 * (at your option) any later version. *
18 * This program is distributed in the hope that it will be useful, *
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
21 * GNU General Public License for more details. *
23 * You should have received a copy of the GNU General Public License *
24 * along with this program; if not, write to the *
25 * Free Software Foundation, Inc., *
26 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
27 ***************************************************************************/
32 #include "replacements.h"
50 int usbprog_execute_queue(void);
51 int usbprog_speed(int speed);
52 int usbprog_register_commands(struct command_context_s *cmd_ctx);
53 int usbprog_init(void);
54 int usbprog_quit(void);
56 void usbprog_end_state(enum tap_state state);
57 void usbprog_state_move(void);
58 void usbprog_path_move(pathmove_command_t *cmd);
59 void usbprog_runtest(int num_cycles);
60 void usbprog_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size);
62 jtag_interface_t usbprog_interface =
65 .execute_queue = usbprog_execute_queue,
66 .speed = usbprog_speed,
67 .register_commands = usbprog_register_commands,
72 #define UNKOWN_COMMAND 0x00
73 #define PORT_DIRECTION 0x01
76 #define PORT_SETBIT 0x04
77 #define PORT_GETBIT 0x05
78 #define WRITE_TDI 0x06
80 #define WRITE_AND_READ 0x08
81 #define WRITE_TMS 0x09
82 #define WRITE_TMS_CHAIN 0x0A
86 struct usb_dev_handle* usb_handle;
89 struct usbprog_jtag * usbprog_jtag_handle;
91 struct usbprog_jtag* usbprog_jtag_open();
92 void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag);
93 void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag);
94 unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen);
96 void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char * buffer, int size);
97 void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char * buffer, int size);
98 void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char * buffer, int size);
99 void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan);
103 void usbprog_jtag_tms_collect(char tms_scan);
104 void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag);
106 void usbprog_write(int tck, int tms, int tdi);
107 void usbprog_reset(int trst, int srst);
109 void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction);
110 void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag,unsigned char value);
111 unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag);
112 void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag,int bit, int value);
113 int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit);
115 int usbprog_speed(int speed)
120 int usbprog_register_commands(struct command_context_s *cmd_ctx)
125 int usbprog_execute_queue(void)
127 jtag_command_t *cmd = jtag_command_queue; /* currently processed command */
137 #ifdef _DEBUG_JTAG_IO_
138 DEBUG("end_state: %i", cmd->cmd.end_state->end_state);
140 if (cmd->cmd.end_state->end_state != -1)
141 usbprog_end_state(cmd->cmd.end_state->end_state);
144 #ifdef _DEBUG_JTAG_IO_
145 DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
147 if (cmd->cmd.reset->trst == 1)
151 usbprog_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
154 #ifdef _DEBUG_JTAG_IO_
155 DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
157 if (cmd->cmd.runtest->end_state != -1)
158 usbprog_end_state(cmd->cmd.runtest->end_state);
159 usbprog_runtest(cmd->cmd.runtest->num_cycles);
162 #ifdef _DEBUG_JTAG_IO_
163 DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
165 if (cmd->cmd.statemove->end_state != -1)
166 usbprog_end_state(cmd->cmd.statemove->end_state);
167 usbprog_state_move();
170 #ifdef _DEBUG_JTAG_IO_
171 DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states,
172 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
174 usbprog_path_move(cmd->cmd.pathmove);
177 #ifdef _DEBUG_JTAG_IO_
178 DEBUG("scan end in %i", cmd->cmd.scan->end_state);
180 if (cmd->cmd.scan->end_state != -1)
181 usbprog_end_state(cmd->cmd.scan->end_state);
182 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
183 type = jtag_scan_type(cmd->cmd.scan);
184 usbprog_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size);
185 if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
186 return ERROR_JTAG_QUEUE_FAILED;
191 #ifdef _DEBUG_JTAG_IO_
192 DEBUG("sleep %i", cmd->cmd.sleep->us);
194 jtag_sleep(cmd->cmd.sleep->us);
197 ERROR("BUG: unknown JTAG command type encountered");
207 int usbprog_init(void)
209 usbprog_jtag_handle = usbprog_jtag_open();
212 if (usbprog_jtag_handle == 0)
214 ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
215 return ERROR_JTAG_INIT_FAILED;
218 INFO("USB JTAG Interface ready!");
220 usbprog_jtag_init(usbprog_jtag_handle);
222 usbprog_write(0, 0, 0);
227 int usbprog_quit(void)
232 /*************** jtag execute commands **********************/
233 void usbprog_end_state(enum tap_state state)
235 if (tap_move_map[state] != -1)
239 ERROR("BUG: %i is not a valid end state", state);
244 void usbprog_state_move(void)
247 u8 tms_scan = TAP_MOVE(cur_state, end_state);
249 usbprog_jtag_write_tms(usbprog_jtag_handle, (char)tms_scan);
250 for (i = 0; i < 7; i++)
252 tms = (tms_scan >> i) & 1;
255 cur_state = end_state;
258 void usbprog_path_move(pathmove_command_t *cmd)
260 int num_states = cmd->num_states;
266 if (tap_transitions[cur_state].low == cmd->path[state_count])
269 usbprog_write(0, 0, 0);
270 usbprog_write(1, 0, 0);
272 else if (tap_transitions[cur_state].high == cmd->path[state_count])
275 usbprog_write(0, 1, 0);
276 usbprog_write(1, 1, 0);
280 ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_strings[cur_state], tap_state_strings[cmd->path[state_count]]);
284 cur_state = cmd->path[state_count];
289 end_state = cur_state;
292 void usbprog_runtest(int num_cycles)
296 /* only do a state_move when we're not already in RTI */
297 if (cur_state != TAP_RTI)
299 usbprog_end_state(TAP_RTI);
300 usbprog_state_move();
303 /* execute num_cycles */
306 usbprog_jtag_tms_send(usbprog_jtag_handle);
307 usbprog_write(0, 0, 0);
311 usbprog_jtag_tms_send(usbprog_jtag_handle);
312 //INFO("NUM CYCLES %i",num_cycles);
315 for (i = 0; i < num_cycles; i++)
317 usbprog_write(1, 0, 0);
318 usbprog_write(0, 0, 0);
321 /* finish in end_state */
323 usbprog_end_state(saved_end_state);
324 if (cur_state != end_state)
325 usbprog_state_move();
329 void usbprog_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
331 enum tap_state saved_end_state = end_state;
334 usbprog_end_state(TAP_SI);
336 usbprog_end_state(TAP_SD);
338 //usbprog_jtag_tms_send(usbprog_jtag_handle);
340 usbprog_state_move();
341 usbprog_end_state(saved_end_state);
343 usbprog_jtag_tms_send(usbprog_jtag_handle);
345 if (type == SCAN_OUT)
347 usbprog_jtag_write_tdi(usbprog_jtag_handle,buffer, scan_size);
351 usbprog_jtag_read_tdo(usbprog_jtag_handle,buffer, scan_size);
355 usbprog_jtag_write_and_read(usbprog_jtag_handle,buffer, scan_size);
363 if (cur_state != end_state)
364 usbprog_state_move();
367 /*************** jtag wrapper functions *********************/
369 void usbprog_write(int tck, int tms, int tdi)
371 unsigned char output_value=0x00;
374 output_value |= (1<<TMS_BIT);
376 output_value |= (1<<TDI_BIT);
378 output_value |= (1<<TCK_BIT);
380 usbprog_jtag_write_slice(usbprog_jtag_handle,output_value);
383 /* (1) assert or (0) deassert reset lines */
384 void usbprog_reset(int trst, int srst)
386 DEBUG("trst: %i, srst: %i", trst, srst);
389 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 0);
391 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 1);
394 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 0);
396 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 1);
399 /*************** jtag lowlevel functions ********************/
401 struct usb_bus *busses;
403 struct usbprog_jtag* usbprog_jtag_open()
406 struct usb_device *dev;
408 struct usbprog_jtag *tmp;
410 tmp = (struct usbprog_jtag*)malloc(sizeof(struct usbprog_jtag));
417 busses = usb_get_busses();
419 /* find usbprog_jtag device in usb bus */
421 for (bus = busses; bus; bus = bus->next)
423 for (dev = bus->devices; dev; dev = dev->next)
425 /* condition for sucessfully hit (too bad, I only check the vendor id)*/
426 if (dev->descriptor.idVendor == VID && dev->descriptor.idProduct == PID)
428 tmp->usb_handle = usb_open(dev);
429 usb_set_configuration(tmp->usb_handle, 1);
430 usb_claim_interface(tmp->usb_handle, 0);
431 usb_set_altinterface(tmp->usb_handle, 0);
439 void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag)
441 usb_close(usbprog_jtag->usb_handle);
445 unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen)
447 int res = usb_bulk_write(usbprog_jtag->usb_handle, 3, msg,msglen, 100);
448 if ((msg[0] == 2) || (msg[0] == 1) || (msg[0] == 4) || (msg[0] == 0) || \
449 (msg[0] == 6) || (msg[0] == 0x0A) || (msg[0] == 9))
453 //INFO("HALLLLOOO %i",(int)msg[0]);
454 res = usb_bulk_read(usbprog_jtag->usb_handle, 0x82, msg, 2, 100);
456 return (unsigned char)msg[1];
465 void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag)
467 usbprog_jtag_set_direction(usbprog_jtag, 0xFE);
470 void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char * buffer, int size)
472 char tmp[64]; /* fastes packet size for usb controller */
473 int send_bits, bufindex = 0, fillindex = 0, i, loops;
476 /* 61 byte can be transfered (488 bit) */
493 tmp[0] = WRITE_AND_READ;
494 tmp[1] = (char)(send_bits >> 8); /* high */
495 tmp[2] = (char)(send_bits); /* low */
498 for (i = 0; i < loops; i++)
500 tmp[3 + i] = buffer[bufindex];
504 if (usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000) == 64)
506 //INFO("HALLLLOOO2 %i",(int)tmp[0]);
509 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 1000) < 1)
516 for (i = 0; i < loops; i++)
519 buffer[fillindex++] = swap;
525 void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char * buffer, int size)
527 char tmp[64]; /* fastes packet size for usb controller */
528 int send_bits, fillindex = 0, i, loops;
531 /* 61 byte can be transfered (488 bit) */
548 tmp[0] = WRITE_AND_READ;
549 tmp[1] = (char)(send_bits >> 8); /* high */
550 tmp[2] = (char)(send_bits); /* low */
552 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 3, 1000);
554 //INFO("HALLLLOOO3 %i",(int)tmp[0]);
557 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 10) < 1)
564 for (i = 0; i < loops; i++)
567 buffer[fillindex++] = swap;
572 void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char * buffer, int size)
574 char tmp[64]; /* fastes packet size for usb controller */
575 int send_bits, bufindex = 0, i, loops;
577 /* 61 byte can be transfered (488 bit) */
595 tmp[1] = (char)(send_bits >> 8); /* high */
596 tmp[2] = (char)(send_bits); /* low */
599 for (i = 0; i < loops; i++)
601 tmp[3 + i] = buffer[bufindex];
604 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000);
608 void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan)
610 usbprog_jtag_tms_collect(tms_scan);
613 void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction)
616 tmp[0] = PORT_DIRECTION;
617 tmp[1] = (char)direction;
618 usbprog_jtag_message(usbprog_jtag, tmp, 2);
621 void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag,unsigned char value)
625 tmp[1] = (char)value;
626 usbprog_jtag_message(usbprog_jtag, tmp, 2);
629 unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag)
634 return usbprog_jtag_message(usbprog_jtag, tmp, 2);
637 void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag,int bit, int value)
640 tmp[0] = PORT_SETBIT;
646 usbprog_jtag_message(usbprog_jtag, tmp, 3);
649 int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit)
652 tmp[0] = PORT_GETBIT;
655 if (usbprog_jtag_message(usbprog_jtag, tmp, 2) > 0)
661 void usbprog_jtag_tms_collect(char tms_scan)
663 tms_chain[tms_chain_index] = tms_scan;
667 void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag)
671 if (tms_chain_index > 0)
673 char tmp[tms_chain_index + 2];
674 tmp[0] = WRITE_TMS_CHAIN;
675 tmp[1] = (char)(tms_chain_index);
676 for (i = 0; i < tms_chain_index + 1; i++)
677 tmp[2 + i] = tms_chain[i];
678 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, tms_chain_index + 2, 1000);