1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 /***************************************************************************
4 * Copyright (C) 2007 by Benedikt Sauter *
6 ***************************************************************************/
9 * This file is based on Dominic Rath's amt_jtagaccel.c.
11 * usbprog is a free programming adapter. You can easily install
12 * different firmware versions from an "online pool" over USB.
13 * The adapter can be used for programming and debugging AVR and ARM
14 * processors, as USB to RS232 converter, as JTAG interface or as
15 * simple I/O interface (5 lines).
17 * http://www.embedded-projects.net/usbprog
24 #include <jtag/interface.h>
25 #include <jtag/commands.h>
26 #include "libusb_helper.h"
37 static void usbprog_end_state(tap_state_t state
);
38 static void usbprog_state_move(void);
39 static void usbprog_path_move(struct pathmove_command
*cmd
);
40 static void usbprog_runtest(int num_cycles
);
41 static void usbprog_scan(bool ir_scan
, enum scan_type type
, uint8_t *buffer
, int scan_size
);
43 #define UNKNOWN_COMMAND 0x00
44 #define PORT_DIRECTION 0x01
47 #define PORT_SETBIT 0x04
48 #define PORT_GETBIT 0x05
49 #define WRITE_TDI 0x06
51 #define WRITE_AND_READ 0x08
52 #define WRITE_TMS 0x09
53 #define WRITE_TMS_CHAIN 0x0A
56 struct libusb_device_handle
*usb_handle
;
59 static struct usbprog_jtag
*usbprog_jtag_handle
;
61 static struct usbprog_jtag
*usbprog_jtag_open(void);
62 /* static void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag); */
63 static void usbprog_jtag_init(struct usbprog_jtag
*usbprog_jtag
);
64 static unsigned char usbprog_jtag_message(struct usbprog_jtag
*usbprog_jtag
, char *msg
, int msglen
);
66 static void usbprog_jtag_read_tdo(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
);
67 static void usbprog_jtag_write_tdi(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
);
68 static void usbprog_jtag_write_and_read(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
);
69 static void usbprog_jtag_write_tms(struct usbprog_jtag
*usbprog_jtag
, char tms_scan
);
71 static char tms_chain
[64];
72 static int tms_chain_index
;
74 static void usbprog_jtag_tms_collect(char tms_scan
);
75 static void usbprog_jtag_tms_send(struct usbprog_jtag
*usbprog_jtag
);
77 static void usbprog_write(int tck
, int tms
, int tdi
);
78 static void usbprog_reset(int trst
, int srst
);
80 static void usbprog_jtag_set_direction(struct usbprog_jtag
*usbprog_jtag
, unsigned char direction
);
81 static void usbprog_jtag_write_slice(struct usbprog_jtag
*usbprog_jtag
, unsigned char value
);
82 /* static unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag); */
83 static void usbprog_jtag_set_bit(struct usbprog_jtag
*usbprog_jtag
, int bit
, int value
);
84 /* static int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit); */
86 static int usbprog_execute_queue(void)
88 struct jtag_command
*cmd
= jtag_command_queue
; /* currently processed command */
96 LOG_DEBUG_IO("reset trst: %i srst %i",
98 cmd
->cmd
.reset
->srst
);
99 if (cmd
->cmd
.reset
->trst
== 1)
100 tap_set_state(TAP_RESET
);
101 usbprog_reset(cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
104 LOG_DEBUG_IO("runtest %i cycles, end in %i",
105 cmd
->cmd
.runtest
->num_cycles
,
106 cmd
->cmd
.runtest
->end_state
);
107 usbprog_end_state(cmd
->cmd
.runtest
->end_state
);
108 usbprog_runtest(cmd
->cmd
.runtest
->num_cycles
);
111 LOG_DEBUG_IO("statemove end in %i", cmd
->cmd
.statemove
->end_state
);
112 usbprog_end_state(cmd
->cmd
.statemove
->end_state
);
113 usbprog_state_move();
116 LOG_DEBUG_IO("pathmove: %i states, end in %i",
117 cmd
->cmd
.pathmove
->num_states
,
118 cmd
->cmd
.pathmove
->path
[cmd
->cmd
.pathmove
->num_states
- 1]);
119 usbprog_path_move(cmd
->cmd
.pathmove
);
122 LOG_DEBUG_IO("scan end in %i", cmd
->cmd
.scan
->end_state
);
123 usbprog_end_state(cmd
->cmd
.scan
->end_state
);
124 scan_size
= jtag_build_buffer(cmd
->cmd
.scan
, &buffer
);
125 type
= jtag_scan_type(cmd
->cmd
.scan
);
126 usbprog_scan(cmd
->cmd
.scan
->ir_scan
, type
, buffer
, scan_size
);
127 if (jtag_read_buffer(buffer
, cmd
->cmd
.scan
) != ERROR_OK
)
128 return ERROR_JTAG_QUEUE_FAILED
;
132 LOG_DEBUG_IO("sleep %" PRIu32
, cmd
->cmd
.sleep
->us
);
133 jtag_sleep(cmd
->cmd
.sleep
->us
);
136 LOG_ERROR("BUG: unknown JTAG command type encountered");
146 static int usbprog_init(void)
148 usbprog_jtag_handle
= usbprog_jtag_open();
151 if (usbprog_jtag_handle
== 0) {
152 LOG_ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
153 return ERROR_JTAG_INIT_FAILED
;
156 LOG_INFO("USB JTAG Interface ready!");
158 usbprog_jtag_init(usbprog_jtag_handle
);
160 usbprog_write(0, 0, 0);
165 static int usbprog_quit(void)
170 /*************** jtag execute commands **********************/
171 static void usbprog_end_state(tap_state_t state
)
173 if (tap_is_state_stable(state
))
174 tap_set_end_state(state
);
176 LOG_ERROR("BUG: %i is not a valid end state", state
);
181 static void usbprog_state_move(void)
183 uint8_t tms_scan
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
185 usbprog_jtag_write_tms(usbprog_jtag_handle
, (char)tms_scan
);
187 tap_set_state(tap_get_end_state());
190 static void usbprog_path_move(struct pathmove_command
*cmd
)
192 int num_states
= cmd
->num_states
;
195 /* There may be queued transitions, and before following a specified
196 path, we must flush those queued transitions */
197 usbprog_jtag_tms_send(usbprog_jtag_handle
);
201 if (tap_state_transition(tap_get_state(), false) == cmd
->path
[state_count
]) {
203 usbprog_write(0, 0, 0);
204 usbprog_write(1, 0, 0);
205 } else if (tap_state_transition(tap_get_state(),
206 true) == cmd
->path
[state_count
]) {
208 usbprog_write(0, 1, 0);
209 usbprog_write(1, 1, 0);
211 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
212 tap_state_name(tap_get_state()),
213 tap_state_name(cmd
->path
[state_count
]));
217 tap_set_state(cmd
->path
[state_count
]);
222 tap_set_end_state(tap_get_state());
225 static void usbprog_runtest(int num_cycles
)
229 /* only do a state_move when we're not already in IDLE */
230 if (tap_get_state() != TAP_IDLE
) {
231 usbprog_end_state(TAP_IDLE
);
232 usbprog_state_move();
235 /* execute num_cycles */
236 if (num_cycles
> 0) {
237 usbprog_jtag_tms_send(usbprog_jtag_handle
);
238 usbprog_write(0, 0, 0);
240 usbprog_jtag_tms_send(usbprog_jtag_handle
);
241 /* LOG_INFO("NUM CYCLES %i",num_cycles); */
244 for (i
= 0; i
< num_cycles
; i
++) {
245 usbprog_write(1, 0, 0);
246 usbprog_write(0, 0, 0);
249 LOG_DEBUG_IO("runtest: cur_state %s end_state %s", tap_state_name(
250 tap_get_state()), tap_state_name(tap_get_end_state()));
252 /* finish in end_state */
254 usbprog_end_state(saved_end_state);
255 if (tap_get_state() != tap_get_end_state())
256 usbprog_state_move();
260 static void usbprog_scan(bool ir_scan
, enum scan_type type
, uint8_t *buffer
, int scan_size
)
262 tap_state_t saved_end_state
= tap_get_end_state();
265 usbprog_end_state(TAP_IRSHIFT
);
267 usbprog_end_state(TAP_DRSHIFT
);
269 /* Only move if we're not already there */
270 if (tap_get_state() != tap_get_end_state())
271 usbprog_state_move();
273 usbprog_end_state(saved_end_state
);
275 usbprog_jtag_tms_send(usbprog_jtag_handle
);
277 void (*f
)(struct usbprog_jtag
*usbprog_jtag
, char *buffer_local
, int size
);
280 f
= &usbprog_jtag_write_tdi
;
283 f
= &usbprog_jtag_read_tdo
;
286 f
= &usbprog_jtag_write_and_read
;
289 LOG_ERROR("unknown scan type: %i", type
);
292 f(usbprog_jtag_handle
, (char *)buffer
, scan_size
);
294 /* The adapter does the transition to PAUSE internally */
296 tap_set_state(TAP_IRPAUSE
);
298 tap_set_state(TAP_DRPAUSE
);
300 if (tap_get_state() != tap_get_end_state())
301 usbprog_state_move();
304 /*************** jtag wrapper functions *********************/
306 static void usbprog_write(int tck
, int tms
, int tdi
)
308 unsigned char output_value
= 0x00;
311 output_value
|= (1 << TMS_BIT
);
313 output_value
|= (1 << TDI_BIT
);
315 output_value
|= (1 << TCK_BIT
);
317 usbprog_jtag_write_slice(usbprog_jtag_handle
, output_value
);
320 /* (1) assert or (0) deassert reset lines */
321 static void usbprog_reset(int trst
, int srst
)
323 LOG_DEBUG("trst: %i, srst: %i", trst
, srst
);
326 usbprog_jtag_set_bit(usbprog_jtag_handle
, 5, 0);
328 usbprog_jtag_set_bit(usbprog_jtag_handle
, 5, 1);
331 usbprog_jtag_set_bit(usbprog_jtag_handle
, 4, 0);
333 usbprog_jtag_set_bit(usbprog_jtag_handle
, 4, 1);
336 /*************** jtag lowlevel functions ********************/
338 struct usb_bus
*busses
;
340 struct usbprog_jtag
*usbprog_jtag_open(void)
342 const uint16_t vids
[] = { VID
, 0 };
343 const uint16_t pids
[] = { PID
, 0 };
344 struct libusb_device_handle
*dev
;
346 if (jtag_libusb_open(vids
, pids
, &dev
, NULL
) != ERROR_OK
)
349 struct usbprog_jtag
*tmp
= malloc(sizeof(struct usbprog_jtag
));
350 tmp
->usb_handle
= dev
;
352 libusb_set_configuration(dev
, 1);
353 libusb_claim_interface(dev
, 0);
354 libusb_set_interface_alt_setting(dev
, 0, 0);
360 static void usbprog_jtag_close(struct usbprog_jtag
*usbprog_jtag
)
362 libusb_close(usbprog_jtag
->usb_handle
);
367 static unsigned char usbprog_jtag_message(struct usbprog_jtag
*usbprog_jtag
, char *msg
, int msglen
)
371 int res
= jtag_libusb_bulk_write(usbprog_jtag
->usb_handle
, 3, msg
, msglen
, 100, &transferred
);
372 if ((msg
[0] == 2) || (msg
[0] == 1) || (msg
[0] == 4) || (msg
[0] == 0) ||
373 (msg
[0] == 6) || (msg
[0] == 0x0A) || (msg
[0] == 9))
375 if (res
== ERROR_OK
&& transferred
== msglen
) {
376 /* LOG_INFO("HALLLLOOO %i",(int)msg[0]); */
377 res
= jtag_libusb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, msg
, 2, 100, &transferred
);
378 if (res
== ERROR_OK
&& transferred
> 0)
379 return (unsigned char)msg
[1];
387 static void usbprog_jtag_init(struct usbprog_jtag
*usbprog_jtag
)
389 usbprog_jtag_set_direction(usbprog_jtag
, 0xFE);
392 static void usbprog_jtag_write_and_read(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
)
394 char tmp
[64]; /* fastest packet size for usb controller */
395 int send_bits
, bufindex
= 0, fillindex
= 0, i
, loops
;
398 /* 61 byte can be transferred (488 bit) */
411 tmp
[0] = WRITE_AND_READ
;
412 tmp
[1] = (char)(send_bits
>> 8); /* high */
413 tmp
[2] = (char)(send_bits
); /* low */
415 for (i
= 0; i
< loops
; i
++) {
416 tmp
[3 + i
] = buffer
[bufindex
];
421 int res
= jtag_libusb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 64, 1000, &transferred
);
422 if (res
== ERROR_OK
&& transferred
== 64) {
423 /* LOG_INFO("HALLLLOOO2 %i",(int)tmp[0]); */
426 while (jtag_libusb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, tmp
, 64, 1000, &transferred
) != ERROR_OK
) {
432 for (i
= 0; i
< loops
; i
++) {
434 buffer
[fillindex
++] = swap
;
440 static void usbprog_jtag_read_tdo(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
)
442 char tmp
[64]; /* fastest packet size for usb controller */
443 int send_bits
, fillindex
= 0, i
, loops
;
446 /* 61 byte can be transferred (488 bit) */
459 tmp
[0] = WRITE_AND_READ
;
460 tmp
[1] = (char)(send_bits
>> 8); /* high */
461 tmp
[2] = (char)(send_bits
); /* low */
464 jtag_libusb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 3, 1000, &transferred
);
466 /* LOG_INFO("HALLLLOOO3 %i",(int)tmp[0]); */
469 while (jtag_libusb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, tmp
, 64, 10, &transferred
) != ERROR_OK
) {
475 for (i
= 0; i
< loops
; i
++) {
477 buffer
[fillindex
++] = swap
;
482 static void usbprog_jtag_write_tdi(struct usbprog_jtag
*usbprog_jtag
, char *buffer
, int size
)
484 char tmp
[64]; /* fastest packet size for usb controller */
485 int send_bits
, bufindex
= 0, i
, loops
;
487 /* 61 byte can be transferred (488 bit) */
496 /* if (loops == 0) */
501 tmp
[1] = (char)(send_bits
>> 8); /* high */
502 tmp
[2] = (char)(send_bits
); /* low */
504 for (i
= 0; i
< loops
; i
++) {
505 tmp
[3 + i
] = buffer
[bufindex
];
509 jtag_libusb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 64, 1000, &transferred
);
513 static void usbprog_jtag_write_tms(struct usbprog_jtag
*usbprog_jtag
, char tms_scan
)
515 usbprog_jtag_tms_collect(tms_scan
);
518 static void usbprog_jtag_set_direction(struct usbprog_jtag
*usbprog_jtag
, unsigned char direction
)
521 tmp
[0] = PORT_DIRECTION
;
522 tmp
[1] = (char)direction
;
523 usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
526 static void usbprog_jtag_write_slice(struct usbprog_jtag
*usbprog_jtag
, unsigned char value
)
530 tmp
[1] = (char)value
;
531 usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
535 static unsigned char usbprog_jtag_get_port(struct usbprog_jtag
*usbprog_jtag
)
540 return usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
544 static void usbprog_jtag_set_bit(struct usbprog_jtag
*usbprog_jtag
, int bit
, int value
)
547 tmp
[0] = PORT_SETBIT
;
553 usbprog_jtag_message(usbprog_jtag
, tmp
, 3);
557 static int usbprog_jtag_get_bit(struct usbprog_jtag
*usbprog_jtag
, int bit
)
560 tmp
[0] = PORT_GETBIT
;
563 if (usbprog_jtag_message(usbprog_jtag
, tmp
, 2) > 0)
570 static void usbprog_jtag_tms_collect(char tms_scan
)
572 tms_chain
[tms_chain_index
] = tms_scan
;
576 static void usbprog_jtag_tms_send(struct usbprog_jtag
*usbprog_jtag
)
578 /* LOG_INFO("TMS SEND"); */
579 if (tms_chain_index
> 0) {
580 char tmp
[tms_chain_index
+ 2];
581 tmp
[0] = WRITE_TMS_CHAIN
;
582 tmp
[1] = (char)(tms_chain_index
);
583 for (int i
= 0; i
< tms_chain_index
+ 1; i
++)
584 tmp
[2 + i
] = tms_chain
[i
];
586 jtag_libusb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, tms_chain_index
+ 2, 1000, &transferred
);
591 static struct jtag_interface usbprog_interface
= {
592 .execute_queue
= usbprog_execute_queue
,
595 struct adapter_driver usbprog_adapter_driver
= {
597 .transports
= jtag_only
,
599 .init
= usbprog_init
,
600 .quit
= usbprog_quit
,
602 .jtag_ops
= &usbprog_interface
,