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 ***************************************************************************/
33 #include "replacements.h"
51 int usbprog_execute_queue(void);
52 int usbprog_speed(int speed);
53 int usbprog_register_commands(struct command_context_s *cmd_ctx);
54 int usbprog_init(void);
55 int usbprog_quit(void);
57 void usbprog_end_state(enum tap_state state);
58 void usbprog_state_move(void);
59 void usbprog_path_move(pathmove_command_t *cmd);
60 void usbprog_runtest(int num_cycles);
61 void usbprog_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size);
63 jtag_interface_t usbprog_interface =
66 .execute_queue = usbprog_execute_queue,
67 .support_pathmove = 0,
68 .speed = usbprog_speed,
69 .register_commands = usbprog_register_commands,
74 #define UNKOWN_COMMAND 0x00
75 #define PORT_DIRECTION 0x01
78 #define PORT_SETBIT 0x04
79 #define PORT_GETBIT 0x05
80 #define WRITE_TDI 0x06
82 #define WRITE_AND_READ 0x08
83 #define WRITE_TMS 0x09
84 #define WRITE_TMS_CHAIN 0x0A
88 struct usb_dev_handle* usb_handle;
91 struct usbprog_jtag * usbprog_jtag_handle;
93 struct usbprog_jtag* usbprog_jtag_open();
94 void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag);
95 void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag);
96 unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen);
98 void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char * buffer, int size);
99 void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char * buffer, int size);
100 void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char * buffer, int size);
101 void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan);
105 void usbprog_jtag_tms_collect(char tms_scan);
106 void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag);
108 void usbprog_write(int tck, int tms, int tdi);
109 void usbprog_reset(int trst, int srst);
111 void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction);
112 void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag,unsigned char value);
113 unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag);
114 void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag,int bit, int value);
115 int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit);
117 int usbprog_speed(int speed)
122 int usbprog_register_commands(struct command_context_s *cmd_ctx)
127 int usbprog_execute_queue(void)
129 jtag_command_t *cmd = jtag_command_queue; /* currently processed command */
139 #ifdef _DEBUG_JTAG_IO_
140 DEBUG("end_state: %i", cmd->cmd.end_state->end_state);
142 if (cmd->cmd.end_state->end_state != -1)
143 usbprog_end_state(cmd->cmd.end_state->end_state);
146 #ifdef _DEBUG_JTAG_IO_
147 DEBUG("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
149 if (cmd->cmd.reset->trst == 1)
153 usbprog_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
156 #ifdef _DEBUG_JTAG_IO_
157 DEBUG("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, cmd->cmd.runtest->end_state);
159 if (cmd->cmd.runtest->end_state != -1)
160 usbprog_end_state(cmd->cmd.runtest->end_state);
161 usbprog_runtest(cmd->cmd.runtest->num_cycles);
164 #ifdef _DEBUG_JTAG_IO_
165 DEBUG("statemove end in %i", cmd->cmd.statemove->end_state);
167 if (cmd->cmd.statemove->end_state != -1)
168 usbprog_end_state(cmd->cmd.statemove->end_state);
169 usbprog_state_move();
172 #ifdef _DEBUG_JTAG_IO_
173 DEBUG("pathmove: %i states, end in %i", cmd->cmd.pathmove->num_states,
174 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
176 usbprog_path_move(cmd->cmd.pathmove);
179 #ifdef _DEBUG_JTAG_IO_
180 DEBUG("scan end in %i", cmd->cmd.scan->end_state);
182 if (cmd->cmd.scan->end_state != -1)
183 usbprog_end_state(cmd->cmd.scan->end_state);
184 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
185 type = jtag_scan_type(cmd->cmd.scan);
186 usbprog_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size);
187 if (jtag_read_buffer(buffer, cmd->cmd.scan) != ERROR_OK)
188 return ERROR_JTAG_QUEUE_FAILED;
193 #ifdef _DEBUG_JTAG_IO_
194 DEBUG("sleep %i", cmd->cmd.sleep->us);
196 jtag_sleep(cmd->cmd.sleep->us);
199 ERROR("BUG: unknown JTAG command type encountered");
209 int usbprog_init(void)
211 usbprog_jtag_handle = usbprog_jtag_open();
214 if (usbprog_jtag_handle == 0)
216 ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
217 return ERROR_JTAG_INIT_FAILED;
220 INFO("USB JTAG Interface ready!");
222 usbprog_jtag_init(usbprog_jtag_handle);
224 usbprog_write(0, 0, 0);
229 int usbprog_quit(void)
234 /*************** jtag execute commands **********************/
235 void usbprog_end_state(enum tap_state state)
237 if (tap_move_map[state] != -1)
241 ERROR("BUG: %i is not a valid end state", state);
246 void usbprog_state_move(void)
249 u8 tms_scan = TAP_MOVE(cur_state, end_state);
251 usbprog_jtag_write_tms(usbprog_jtag_handle, (char)tms_scan);
252 for (i = 0; i < 7; i++)
254 tms = (tms_scan >> i) & 1;
257 cur_state = end_state;
260 void usbprog_path_move(pathmove_command_t *cmd)
262 int num_states = cmd->num_states;
268 if (tap_transitions[cur_state].low == cmd->path[state_count])
271 usbprog_write(0, 0, 0);
272 usbprog_write(1, 0, 0);
274 else if (tap_transitions[cur_state].high == cmd->path[state_count])
277 usbprog_write(0, 1, 0);
278 usbprog_write(1, 1, 0);
282 ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_strings[cur_state], tap_state_strings[cmd->path[state_count]]);
286 cur_state = cmd->path[state_count];
291 end_state = cur_state;
294 void usbprog_runtest(int num_cycles)
298 /* only do a state_move when we're not already in RTI */
299 if (cur_state != TAP_RTI)
301 usbprog_end_state(TAP_RTI);
302 usbprog_state_move();
305 /* execute num_cycles */
308 usbprog_jtag_tms_send(usbprog_jtag_handle);
309 usbprog_write(0, 0, 0);
313 usbprog_jtag_tms_send(usbprog_jtag_handle);
314 //INFO("NUM CYCLES %i",num_cycles);
317 for (i = 0; i < num_cycles; i++)
319 usbprog_write(1, 0, 0);
320 usbprog_write(0, 0, 0);
323 /* finish in end_state */
325 usbprog_end_state(saved_end_state);
326 if (cur_state != end_state)
327 usbprog_state_move();
331 void usbprog_scan(int ir_scan, enum scan_type type, u8 *buffer, int scan_size)
333 enum tap_state saved_end_state = end_state;
336 usbprog_end_state(TAP_SI);
338 usbprog_end_state(TAP_SD);
340 //usbprog_jtag_tms_send(usbprog_jtag_handle);
342 usbprog_state_move();
343 usbprog_end_state(saved_end_state);
345 usbprog_jtag_tms_send(usbprog_jtag_handle);
347 if (type == SCAN_OUT)
349 usbprog_jtag_write_tdi(usbprog_jtag_handle,buffer, scan_size);
353 usbprog_jtag_read_tdo(usbprog_jtag_handle,buffer, scan_size);
357 usbprog_jtag_write_and_read(usbprog_jtag_handle,buffer, scan_size);
365 if (cur_state != end_state)
366 usbprog_state_move();
369 /*************** jtag wrapper functions *********************/
371 void usbprog_write(int tck, int tms, int tdi)
373 unsigned char output_value=0x00;
376 output_value |= (1<<TMS_BIT);
378 output_value |= (1<<TDI_BIT);
380 output_value |= (1<<TCK_BIT);
382 usbprog_jtag_write_slice(usbprog_jtag_handle,output_value);
385 /* (1) assert or (0) deassert reset lines */
386 void usbprog_reset(int trst, int srst)
388 DEBUG("trst: %i, srst: %i", trst, srst);
391 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 0);
393 usbprog_jtag_set_bit(usbprog_jtag_handle, 5, 1);
396 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 0);
398 usbprog_jtag_set_bit(usbprog_jtag_handle, 4, 1);
401 /*************** jtag lowlevel functions ********************/
403 struct usb_bus *busses;
405 struct usbprog_jtag* usbprog_jtag_open()
408 struct usb_device *dev;
410 struct usbprog_jtag *tmp;
412 tmp = (struct usbprog_jtag*)malloc(sizeof(struct usbprog_jtag));
419 busses = usb_get_busses();
421 /* find usbprog_jtag device in usb bus */
423 for (bus = busses; bus; bus = bus->next)
425 for (dev = bus->devices; dev; dev = dev->next)
427 /* condition for sucessfully hit (too bad, I only check the vendor id)*/
428 if (dev->descriptor.idVendor == VID && dev->descriptor.idProduct == PID)
430 tmp->usb_handle = usb_open(dev);
431 usb_set_configuration(tmp->usb_handle, 1);
432 usb_claim_interface(tmp->usb_handle, 0);
433 usb_set_altinterface(tmp->usb_handle, 0);
441 void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag)
443 usb_close(usbprog_jtag->usb_handle);
447 unsigned char usbprog_jtag_message(struct usbprog_jtag *usbprog_jtag, char *msg, int msglen)
449 int res = usb_bulk_write(usbprog_jtag->usb_handle, 3, msg,msglen, 100);
450 if ((msg[0] == 2) || (msg[0] == 1) || (msg[0] == 4) || (msg[0] == 0) || \
451 (msg[0] == 6) || (msg[0] == 0x0A) || (msg[0] == 9))
455 //INFO("HALLLLOOO %i",(int)msg[0]);
456 res = usb_bulk_read(usbprog_jtag->usb_handle, 0x82, msg, 2, 100);
458 return (unsigned char)msg[1];
467 void usbprog_jtag_init(struct usbprog_jtag *usbprog_jtag)
469 usbprog_jtag_set_direction(usbprog_jtag, 0xFE);
472 void usbprog_jtag_write_and_read(struct usbprog_jtag *usbprog_jtag, char * buffer, int size)
474 char tmp[64]; // fastes packet size for usb controller
475 int send_bits, bufindex = 0, fillindex = 0, i, loops;
478 // 61 byte can be transfered (488 bit)
495 tmp[0] = WRITE_AND_READ;
496 tmp[1] = (char)(send_bits >> 8); // high
497 tmp[2] = (char)(send_bits); // low
500 for (i = 0; i < loops; i++)
502 tmp[3 + i] = buffer[bufindex];
506 if (usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000) == 64)
508 //INFO("HALLLLOOO2 %i",(int)tmp[0]);
511 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 1000) < 1)
518 for (i = 0; i < loops; i++)
521 buffer[fillindex++] = swap;
527 void usbprog_jtag_read_tdo(struct usbprog_jtag *usbprog_jtag, char * buffer, int size)
529 char tmp[64]; // fastes packet size for usb controller
530 int send_bits, fillindex = 0, i, loops;
533 // 61 byte can be transfered (488 bit)
550 tmp[0] = WRITE_AND_READ;
551 tmp[1] = (char)(send_bits >> 8); // high
552 tmp[2] = (char)(send_bits); // low
554 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 3, 1000);
556 //INFO("HALLLLOOO3 %i",(int)tmp[0]);
559 while (usb_bulk_read(usbprog_jtag->usb_handle, 0x82, tmp, 64, 10) < 1)
566 for (i = 0; i < loops; i++)
569 buffer[fillindex++] = swap;
574 void usbprog_jtag_write_tdi(struct usbprog_jtag *usbprog_jtag, char * buffer, int size)
576 char tmp[64]; // fastes packet size for usb controller
577 int send_bits, bufindex = 0, i, loops;
579 // 61 byte can be transfered (488 bit)
597 tmp[1] = (char)(send_bits >> 8); // high
598 tmp[2] = (char)(send_bits); // low
601 for (i = 0; i < loops; i++)
603 tmp[3 + i] = buffer[bufindex];
606 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, 64, 1000);
610 void usbprog_jtag_write_tms(struct usbprog_jtag *usbprog_jtag, char tms_scan)
612 usbprog_jtag_tms_collect(tms_scan);
615 void usbprog_jtag_set_direction(struct usbprog_jtag *usbprog_jtag, unsigned char direction)
618 tmp[0] = PORT_DIRECTION;
619 tmp[1] = (char)direction;
620 usbprog_jtag_message(usbprog_jtag, tmp, 2);
623 void usbprog_jtag_write_slice(struct usbprog_jtag *usbprog_jtag,unsigned char value)
627 tmp[1] = (char)value;
628 usbprog_jtag_message(usbprog_jtag, tmp, 2);
631 unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag)
636 return usbprog_jtag_message(usbprog_jtag, tmp, 2);
639 void usbprog_jtag_set_bit(struct usbprog_jtag *usbprog_jtag,int bit, int value)
642 tmp[0] = PORT_SETBIT;
648 usbprog_jtag_message(usbprog_jtag, tmp, 3);
651 int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit)
654 tmp[0] = PORT_GETBIT;
657 if (usbprog_jtag_message(usbprog_jtag, tmp, 2) > 0)
663 void usbprog_jtag_tms_collect(char tms_scan)
665 tms_chain[tms_chain_index] = tms_scan;
669 void usbprog_jtag_tms_send(struct usbprog_jtag *usbprog_jtag)
673 if (tms_chain_index > 0)
675 char tmp[tms_chain_index + 2];
676 tmp[0] = WRITE_TMS_CHAIN;
677 tmp[1] = (char)(tms_chain_index);
678 for (i = 0; i < tms_chain_index + 1; i++)
679 tmp[2 + i] = tms_chain[i];
680 usb_bulk_write(usbprog_jtag->usb_handle, 3, tmp, tms_chain_index + 2, 1000);