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