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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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_speed(int speed
)
104 static int usbprog_execute_queue(void)
106 struct jtag_command
*cmd
= jtag_command_queue
; /* currently processed command */
114 #ifdef _DEBUG_JTAG_IO_
115 LOG_DEBUG("reset trst: %i srst %i",
116 cmd
->cmd
.reset
->trst
,
117 cmd
->cmd
.reset
->srst
);
119 if (cmd
->cmd
.reset
->trst
== 1)
120 tap_set_state(TAP_RESET
);
121 usbprog_reset(cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
124 #ifdef _DEBUG_JTAG_IO_
125 LOG_DEBUG("runtest %i cycles, end in %i",
126 cmd
->cmd
.runtest
->num_cycles
,
127 cmd
->cmd
.runtest
->end_state
);
129 usbprog_end_state(cmd
->cmd
.runtest
->end_state
);
130 usbprog_runtest(cmd
->cmd
.runtest
->num_cycles
);
133 #ifdef _DEBUG_JTAG_IO_
134 LOG_DEBUG("statemove end in %i", cmd
->cmd
.statemove
->end_state
);
136 usbprog_end_state(cmd
->cmd
.statemove
->end_state
);
137 usbprog_state_move();
140 #ifdef _DEBUG_JTAG_IO_
141 LOG_DEBUG("pathmove: %i states, end in %i",
142 cmd
->cmd
.pathmove
->num_states
,
143 cmd
->cmd
.pathmove
->path
[cmd
->cmd
.pathmove
->num_states
- 1]);
145 usbprog_path_move(cmd
->cmd
.pathmove
);
148 #ifdef _DEBUG_JTAG_IO_
149 LOG_DEBUG("scan end in %i", cmd
->cmd
.scan
->end_state
);
151 usbprog_end_state(cmd
->cmd
.scan
->end_state
);
152 scan_size
= jtag_build_buffer(cmd
->cmd
.scan
, &buffer
);
153 type
= jtag_scan_type(cmd
->cmd
.scan
);
154 usbprog_scan(cmd
->cmd
.scan
->ir_scan
, type
, buffer
, scan_size
);
155 if (jtag_read_buffer(buffer
, cmd
->cmd
.scan
) != ERROR_OK
)
156 return ERROR_JTAG_QUEUE_FAILED
;
161 #ifdef _DEBUG_JTAG_IO_
162 LOG_DEBUG("sleep %i", cmd
->cmd
.sleep
->us
);
164 jtag_sleep(cmd
->cmd
.sleep
->us
);
167 LOG_ERROR("BUG: unknown JTAG command type encountered");
177 static int usbprog_init(void)
179 usbprog_jtag_handle
= usbprog_jtag_open();
182 if (usbprog_jtag_handle
== 0) {
183 LOG_ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
184 return ERROR_JTAG_INIT_FAILED
;
187 LOG_INFO("USB JTAG Interface ready!");
189 usbprog_jtag_init(usbprog_jtag_handle
);
191 usbprog_write(0, 0, 0);
196 static int usbprog_quit(void)
201 /*************** jtag execute commands **********************/
202 static void usbprog_end_state(tap_state_t state
)
204 if (tap_is_state_stable(state
))
205 tap_set_end_state(state
);
207 LOG_ERROR("BUG: %i is not a valid end state", state
);
212 static void usbprog_state_move(void)
214 uint8_t tms_scan
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
216 usbprog_jtag_write_tms(usbprog_jtag_handle
, (char)tms_scan
);
218 tap_set_state(tap_get_end_state());
221 static void usbprog_path_move(struct pathmove_command
*cmd
)
223 int num_states
= cmd
->num_states
;
226 /* There may be queued transitions, and before following a specified
227 path, we must flush those queued transitions */
228 usbprog_jtag_tms_send(usbprog_jtag_handle
);
232 if (tap_state_transition(tap_get_state(), false) == cmd
->path
[state_count
]) {
234 usbprog_write(0, 0, 0);
235 usbprog_write(1, 0, 0);
236 } else if (tap_state_transition(tap_get_state(),
237 true) == cmd
->path
[state_count
]) {
239 usbprog_write(0, 1, 0);
240 usbprog_write(1, 1, 0);
242 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
243 tap_state_name(tap_get_state()),
244 tap_state_name(cmd
->path
[state_count
]));
248 tap_set_state(cmd
->path
[state_count
]);
253 tap_set_end_state(tap_get_state());
256 static void usbprog_runtest(int num_cycles
)
260 /* only do a state_move when we're not already in IDLE */
261 if (tap_get_state() != TAP_IDLE
) {
262 usbprog_end_state(TAP_IDLE
);
263 usbprog_state_move();
266 /* execute num_cycles */
267 if (num_cycles
> 0) {
268 usbprog_jtag_tms_send(usbprog_jtag_handle
);
269 usbprog_write(0, 0, 0);
271 usbprog_jtag_tms_send(usbprog_jtag_handle
);
272 /* LOG_INFO("NUM CYCLES %i",num_cycles); */
275 for (i
= 0; i
< num_cycles
; i
++) {
276 usbprog_write(1, 0, 0);
277 usbprog_write(0, 0, 0);
280 #ifdef _DEBUG_JTAG_IO_
281 LOG_DEBUG("runtest: cur_state %s end_state %s", tap_state_name(
282 tap_get_state()), tap_state_name(tap_get_end_state()));
285 /* finish in end_state */
287 usbprog_end_state(saved_end_state);
288 if (tap_get_state() != tap_get_end_state())
289 usbprog_state_move();
293 static void usbprog_scan(bool ir_scan
, enum scan_type type
, uint8_t *buffer
, int scan_size
)
295 tap_state_t saved_end_state
= tap_get_end_state();
298 usbprog_end_state(TAP_IRSHIFT
);
300 usbprog_end_state(TAP_DRSHIFT
);
302 /* Only move if we're not already there */
303 if (tap_get_state() != tap_get_end_state())
304 usbprog_state_move();
306 usbprog_end_state(saved_end_state
);
308 usbprog_jtag_tms_send(usbprog_jtag_handle
);
310 void (*f
)(struct usbprog_jtag
*usbprog_jtag
, char *buffer_local
, int size
);
313 f
= &usbprog_jtag_write_tdi
;
316 f
= &usbprog_jtag_read_tdo
;
319 f
= &usbprog_jtag_write_and_read
;
322 LOG_ERROR("unknown scan type: %i", type
);
325 f(usbprog_jtag_handle
, (char *)buffer
, scan_size
);
327 /* The adapter does the transition to PAUSE internally */
329 tap_set_state(TAP_IRPAUSE
);
331 tap_set_state(TAP_DRPAUSE
);
333 if (tap_get_state() != tap_get_end_state())
334 usbprog_state_move();
337 /*************** jtag wrapper functions *********************/
339 static void usbprog_write(int tck
, int tms
, int tdi
)
341 unsigned char output_value
= 0x00;
344 output_value
|= (1 << TMS_BIT
);
346 output_value
|= (1 << TDI_BIT
);
348 output_value
|= (1 << TCK_BIT
);
350 usbprog_jtag_write_slice(usbprog_jtag_handle
, output_value
);
353 /* (1) assert or (0) deassert reset lines */
354 static void usbprog_reset(int trst
, int srst
)
356 LOG_DEBUG("trst: %i, srst: %i", trst
, srst
);
359 usbprog_jtag_set_bit(usbprog_jtag_handle
, 5, 0);
361 usbprog_jtag_set_bit(usbprog_jtag_handle
, 5, 1);
364 usbprog_jtag_set_bit(usbprog_jtag_handle
, 4, 0);
366 usbprog_jtag_set_bit(usbprog_jtag_handle
, 4, 1);
369 /*************** jtag lowlevel functions ********************/
371 struct usb_bus
*busses
;
373 struct usbprog_jtag
*usbprog_jtag_open(void)
378 const uint16_t vids
[] = { VID
, 0 };
379 const uint16_t pids
[] = { PID
, 0 };
380 struct usb_dev_handle
*dev
;
381 if (jtag_usb_open(vids
, pids
, &dev
) != ERROR_OK
)
384 struct usbprog_jtag
*tmp
= malloc(sizeof(struct usbprog_jtag
));
385 tmp
->usb_handle
= dev
;
387 usb_set_configuration(dev
, 1);
388 usb_claim_interface(dev
, 0);
389 usb_set_altinterface(dev
, 0);
395 static void usbprog_jtag_close(struct usbprog_jtag
*usbprog_jtag
)
397 usb_close(usbprog_jtag
->usb_handle
);
402 static unsigned char usbprog_jtag_message(struct usbprog_jtag
*usbprog_jtag
, char *msg
, int msglen
)
404 int res
= usb_bulk_write(usbprog_jtag
->usb_handle
, 3, msg
, msglen
, 100);
405 if ((msg
[0] == 2) || (msg
[0] == 1) || (msg
[0] == 4) || (msg
[0] == 0) || \
406 (msg
[0] == 6) || (msg
[0] == 0x0A) || (msg
[0] == 9))
409 /* LOG_INFO("HALLLLOOO %i",(int)msg[0]); */
410 res
= usb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, msg
, 2, 100);
412 return (unsigned char)msg
[1];
420 static void usbprog_jtag_init(struct usbprog_jtag
*usbprog_jtag
)
422 usbprog_jtag_set_direction(usbprog_jtag
, 0xFE);
425 static void usbprog_jtag_write_and_read(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
)
427 char tmp
[64]; /* fastes packet size for usb controller */
428 int send_bits
, bufindex
= 0, fillindex
= 0, i
, loops
;
431 /* 61 byte can be transfered (488 bit) */
444 tmp
[0] = WRITE_AND_READ
;
445 tmp
[1] = (char)(send_bits
>> 8); /* high */
446 tmp
[2] = (char)(send_bits
); /* low */
448 for (i
= 0; i
< loops
; i
++) {
449 tmp
[3 + i
] = buffer
[bufindex
];
453 if (usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 64, 1000) == 64) {
454 /* LOG_INFO("HALLLLOOO2 %i",(int)tmp[0]); */
457 while (usb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, tmp
, 64, 1000) < 1) {
463 for (i
= 0; i
< loops
; i
++) {
465 buffer
[fillindex
++] = swap
;
471 static void usbprog_jtag_read_tdo(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
)
473 char tmp
[64]; /* fastes packet size for usb controller */
474 int send_bits
, fillindex
= 0, i
, loops
;
477 /* 61 byte can be transfered (488 bit) */
490 tmp
[0] = WRITE_AND_READ
;
491 tmp
[1] = (char)(send_bits
>> 8); /* high */
492 tmp
[2] = (char)(send_bits
); /* low */
494 usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 3, 1000);
496 /* LOG_INFO("HALLLLOOO3 %i",(int)tmp[0]); */
499 while (usb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, tmp
, 64, 10) < 1) {
505 for (i
= 0; i
< loops
; i
++) {
507 buffer
[fillindex
++] = swap
;
512 static void usbprog_jtag_write_tdi(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
)
514 char tmp
[64]; /* fastes packet size for usb controller */
515 int send_bits
, bufindex
= 0, i
, loops
;
517 /* 61 byte can be transfered (488 bit) */
526 /* if (loops == 0) */
531 tmp
[1] = (char)(send_bits
>> 8); /* high */
532 tmp
[2] = (char)(send_bits
); /* low */
534 for (i
= 0; i
< loops
; i
++) {
535 tmp
[3 + i
] = buffer
[bufindex
];
538 usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 64, 1000);
542 static void usbprog_jtag_write_tms(struct usbprog_jtag
*usbprog_jtag
, char tms_scan
)
544 usbprog_jtag_tms_collect(tms_scan
);
547 static void usbprog_jtag_set_direction(struct usbprog_jtag
*usbprog_jtag
, unsigned char direction
)
550 tmp
[0] = PORT_DIRECTION
;
551 tmp
[1] = (char)direction
;
552 usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
555 static void usbprog_jtag_write_slice(struct usbprog_jtag
*usbprog_jtag
, unsigned char value
)
559 tmp
[1] = (char)value
;
560 usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
564 static unsigned char usbprog_jtag_get_port(struct usbprog_jtag
*usbprog_jtag
)
569 return usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
573 static void usbprog_jtag_set_bit(struct usbprog_jtag
*usbprog_jtag
, int bit
, int value
)
576 tmp
[0] = PORT_SETBIT
;
582 usbprog_jtag_message(usbprog_jtag
, tmp
, 3);
586 static int usbprog_jtag_get_bit(struct usbprog_jtag
*usbprog_jtag
, int bit
)
589 tmp
[0] = PORT_GETBIT
;
592 if (usbprog_jtag_message(usbprog_jtag
, tmp
, 2) > 0)
599 static void usbprog_jtag_tms_collect(char tms_scan
)
601 tms_chain
[tms_chain_index
] = tms_scan
;
605 static void usbprog_jtag_tms_send(struct usbprog_jtag
*usbprog_jtag
)
608 /* LOG_INFO("TMS SEND"); */
609 if (tms_chain_index
> 0) {
610 char tmp
[tms_chain_index
+ 2];
611 tmp
[0] = WRITE_TMS_CHAIN
;
612 tmp
[1] = (char)(tms_chain_index
);
613 for (i
= 0; i
< tms_chain_index
+ 1; i
++)
614 tmp
[2 + i
] = tms_chain
[i
];
615 usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, tms_chain_index
+ 2, 1000);
620 struct jtag_interface usbprog_interface
= {
623 .execute_queue
= usbprog_execute_queue
,
624 .speed
= usbprog_speed
,
625 .init
= usbprog_init
,