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"
51 static void usbprog_end_state(tap_state_t state
);
52 static void usbprog_state_move(void);
53 static void usbprog_path_move(struct pathmove_command
*cmd
);
54 static void usbprog_runtest(int num_cycles
);
55 static void usbprog_scan(bool ir_scan
, enum scan_type type
, uint8_t *buffer
, int scan_size
);
57 #define UNKNOWN_COMMAND 0x00
58 #define PORT_DIRECTION 0x01
61 #define PORT_SETBIT 0x04
62 #define PORT_GETBIT 0x05
63 #define WRITE_TDI 0x06
65 #define WRITE_AND_READ 0x08
66 #define WRITE_TMS 0x09
67 #define WRITE_TMS_CHAIN 0x0A
71 struct usb_dev_handle
* usb_handle
;
74 static struct usbprog_jtag
* usbprog_jtag_handle
;
76 static struct usbprog_jtag
* usbprog_jtag_open(void);
77 //static void usbprog_jtag_close(struct usbprog_jtag *usbprog_jtag);
78 static void usbprog_jtag_init(struct usbprog_jtag
*usbprog_jtag
);
79 static unsigned char usbprog_jtag_message(struct usbprog_jtag
*usbprog_jtag
, char *msg
, int msglen
);
81 static void usbprog_jtag_read_tdo(struct usbprog_jtag
*usbprog_jtag
, char * buffer
, int size
);
82 static void usbprog_jtag_write_tdi(struct usbprog_jtag
*usbprog_jtag
, char * buffer
, int size
);
83 static void usbprog_jtag_write_and_read(struct usbprog_jtag
*usbprog_jtag
, char * buffer
, int size
);
84 static void usbprog_jtag_write_tms(struct usbprog_jtag
*usbprog_jtag
, char tms_scan
);
86 static char tms_chain
[64];
87 static int tms_chain_index
;
89 static void usbprog_jtag_tms_collect(char tms_scan
);
90 static void usbprog_jtag_tms_send(struct usbprog_jtag
*usbprog_jtag
);
92 static void usbprog_write(int tck
, int tms
, int tdi
);
93 static void usbprog_reset(int trst
, int srst
);
95 static void usbprog_jtag_set_direction(struct usbprog_jtag
*usbprog_jtag
, unsigned char direction
);
96 static void usbprog_jtag_write_slice(struct usbprog_jtag
*usbprog_jtag
,unsigned char value
);
97 //static unsigned char usbprog_jtag_get_port(struct usbprog_jtag *usbprog_jtag);
98 static void usbprog_jtag_set_bit(struct usbprog_jtag
*usbprog_jtag
,int bit
, int value
);
99 //static int usbprog_jtag_get_bit(struct usbprog_jtag *usbprog_jtag, int bit);
101 static int usbprog_speed(int speed
)
106 static int usbprog_execute_queue(void)
108 struct jtag_command
*cmd
= jtag_command_queue
; /* currently processed command */
118 #ifdef _DEBUG_JTAG_IO_
119 LOG_DEBUG("reset trst: %i srst %i", cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
121 if (cmd
->cmd
.reset
->trst
== 1)
123 tap_set_state(TAP_RESET
);
125 usbprog_reset(cmd
->cmd
.reset
->trst
, cmd
->cmd
.reset
->srst
);
128 #ifdef _DEBUG_JTAG_IO_
129 LOG_DEBUG("runtest %i cycles, end in %i", cmd
->cmd
.runtest
->num_cycles
, cmd
->cmd
.runtest
->end_state
);
131 usbprog_end_state(cmd
->cmd
.runtest
->end_state
);
132 usbprog_runtest(cmd
->cmd
.runtest
->num_cycles
);
135 #ifdef _DEBUG_JTAG_IO_
136 LOG_DEBUG("statemove end in %i", cmd
->cmd
.statemove
->end_state
);
138 usbprog_end_state(cmd
->cmd
.statemove
->end_state
);
139 usbprog_state_move();
142 #ifdef _DEBUG_JTAG_IO_
143 LOG_DEBUG("pathmove: %i states, end in %i", cmd
->cmd
.pathmove
->num_states
,
144 cmd
->cmd
.pathmove
->path
[cmd
->cmd
.pathmove
->num_states
- 1]);
146 usbprog_path_move(cmd
->cmd
.pathmove
);
149 #ifdef _DEBUG_JTAG_IO_
150 LOG_DEBUG("scan end in %i", cmd
->cmd
.scan
->end_state
);
152 usbprog_end_state(cmd
->cmd
.scan
->end_state
);
153 scan_size
= jtag_build_buffer(cmd
->cmd
.scan
, &buffer
);
154 type
= jtag_scan_type(cmd
->cmd
.scan
);
155 usbprog_scan(cmd
->cmd
.scan
->ir_scan
, type
, buffer
, scan_size
);
156 if (jtag_read_buffer(buffer
, cmd
->cmd
.scan
) != ERROR_OK
)
157 return ERROR_JTAG_QUEUE_FAILED
;
162 #ifdef _DEBUG_JTAG_IO_
163 LOG_DEBUG("sleep %i", cmd
->cmd
.sleep
->us
);
165 jtag_sleep(cmd
->cmd
.sleep
->us
);
168 LOG_ERROR("BUG: unknown JTAG command type encountered");
178 static int usbprog_init(void)
180 usbprog_jtag_handle
= usbprog_jtag_open();
183 if (usbprog_jtag_handle
== 0)
185 LOG_ERROR("Can't find USB JTAG Interface! Please check connection and permissions.");
186 return ERROR_JTAG_INIT_FAILED
;
189 LOG_INFO("USB JTAG Interface ready!");
191 usbprog_jtag_init(usbprog_jtag_handle
);
193 usbprog_write(0, 0, 0);
198 static int usbprog_quit(void)
203 /*************** jtag execute commands **********************/
204 static void usbprog_end_state(tap_state_t state
)
206 if (tap_is_state_stable(state
))
207 tap_set_end_state(state
);
210 LOG_ERROR("BUG: %i is not a valid end state", state
);
215 static void usbprog_state_move(void)
217 uint8_t tms_scan
= tap_get_tms_path(tap_get_state(), tap_get_end_state());
219 usbprog_jtag_write_tms(usbprog_jtag_handle
, (char)tms_scan
);
221 tap_set_state(tap_get_end_state());
224 static void usbprog_path_move(struct pathmove_command
*cmd
)
226 int num_states
= cmd
->num_states
;
229 /* There may be queued transitions, and before following a specified
230 path, we must flush those queued transitions */
231 usbprog_jtag_tms_send(usbprog_jtag_handle
);
236 if (tap_state_transition(tap_get_state(), false) == cmd
->path
[state_count
])
239 usbprog_write(0, 0, 0);
240 usbprog_write(1, 0, 0);
242 else if (tap_state_transition(tap_get_state(), true) == cmd
->path
[state_count
])
245 usbprog_write(0, 1, 0);
246 usbprog_write(1, 1, 0);
250 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(cmd
->path
[state_count
]));
254 tap_set_state(cmd
->path
[state_count
]);
259 tap_set_end_state(tap_get_state());
262 static void usbprog_runtest(int num_cycles
)
266 /* only do a state_move when we're not already in IDLE */
267 if (tap_get_state() != TAP_IDLE
)
269 usbprog_end_state(TAP_IDLE
);
270 usbprog_state_move();
273 /* execute num_cycles */
276 usbprog_jtag_tms_send(usbprog_jtag_handle
);
277 usbprog_write(0, 0, 0);
281 usbprog_jtag_tms_send(usbprog_jtag_handle
);
282 /* LOG_INFO("NUM CYCLES %i",num_cycles); */
285 for (i
= 0; i
< num_cycles
; i
++)
287 usbprog_write(1, 0, 0);
288 usbprog_write(0, 0, 0);
291 #ifdef _DEBUG_JTAG_IO_
292 LOG_DEBUG("runtest: cur_state %s end_state %s", tap_state_name(tap_get_state()), tap_state_name(tap_get_end_state()));
295 /* finish in end_state */
297 usbprog_end_state(saved_end_state);
298 if (tap_get_state() != tap_get_end_state())
299 usbprog_state_move();
303 static void usbprog_scan(bool ir_scan
, enum scan_type type
, uint8_t *buffer
, int scan_size
)
305 tap_state_t saved_end_state
= tap_get_end_state();
308 usbprog_end_state(TAP_IRSHIFT
);
310 usbprog_end_state(TAP_DRSHIFT
);
312 /* Only move if we're not already there */
313 if (tap_get_state() != tap_get_end_state())
314 usbprog_state_move();
316 usbprog_end_state(saved_end_state
);
318 usbprog_jtag_tms_send(usbprog_jtag_handle
);
320 void (*f
)(struct usbprog_jtag
*usbprog_jtag
, char * buffer
, int size
);
322 case SCAN_OUT
: f
= &usbprog_jtag_write_tdi
; break;
323 case SCAN_IN
: f
= &usbprog_jtag_read_tdo
; break;
324 case SCAN_IO
: f
= &usbprog_jtag_write_and_read
; break;
326 LOG_ERROR("unknown scan type: %i", type
);
329 f(usbprog_jtag_handle
, (char *)buffer
, scan_size
);
331 /* The adapter does the transition to PAUSE internally */
333 tap_set_state(TAP_IRPAUSE
);
335 tap_set_state(TAP_DRPAUSE
);
337 if (tap_get_state() != tap_get_end_state())
338 usbprog_state_move();
341 /*************** jtag wrapper functions *********************/
343 static void usbprog_write(int tck
, int tms
, int tdi
)
345 unsigned char output_value
= 0x00;
348 output_value
|= (1 << TMS_BIT
);
350 output_value
|= (1 << TDI_BIT
);
352 output_value
|= (1 << TCK_BIT
);
354 usbprog_jtag_write_slice(usbprog_jtag_handle
,output_value
);
357 /* (1) assert or (0) deassert reset lines */
358 static void usbprog_reset(int trst
, int srst
)
360 LOG_DEBUG("trst: %i, srst: %i", trst
, srst
);
363 usbprog_jtag_set_bit(usbprog_jtag_handle
, 5, 0);
365 usbprog_jtag_set_bit(usbprog_jtag_handle
, 5, 1);
368 usbprog_jtag_set_bit(usbprog_jtag_handle
, 4, 0);
370 usbprog_jtag_set_bit(usbprog_jtag_handle
, 4, 1);
373 /*************** jtag lowlevel functions ********************/
375 struct usb_bus
*busses
;
377 struct usbprog_jtag
* usbprog_jtag_open(void)
382 const uint16_t vids
[] = { VID
, 0 };
383 const uint16_t pids
[] = { PID
, 0 };
384 struct usb_dev_handle
*dev
;
385 if (jtag_usb_open(vids
, pids
, &dev
) != ERROR_OK
)
388 struct usbprog_jtag
*tmp
= malloc(sizeof(struct usbprog_jtag
));
389 tmp
->usb_handle
= dev
;
391 usb_set_configuration(dev
, 1);
392 usb_claim_interface(dev
, 0);
393 usb_set_altinterface(dev
, 0);
399 static void usbprog_jtag_close(struct usbprog_jtag
*usbprog_jtag
)
401 usb_close(usbprog_jtag
->usb_handle
);
406 static unsigned char usbprog_jtag_message(struct usbprog_jtag
*usbprog_jtag
, char *msg
, int msglen
)
408 int res
= usb_bulk_write(usbprog_jtag
->usb_handle
, 3, msg
,msglen
, 100);
409 if ((msg
[0] == 2) || (msg
[0] == 1) || (msg
[0] == 4) || (msg
[0] == 0) || \
410 (msg
[0] == 6) || (msg
[0] == 0x0A) || (msg
[0] == 9))
414 /* LOG_INFO("HALLLLOOO %i",(int)msg[0]); */
415 res
= usb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, msg
, 2, 100);
417 return (unsigned char)msg
[1];
426 static void usbprog_jtag_init(struct usbprog_jtag
*usbprog_jtag
)
428 usbprog_jtag_set_direction(usbprog_jtag
, 0xFE);
431 static void usbprog_jtag_write_and_read(struct usbprog_jtag
*usbprog_jtag
, char * buffer
, int size
)
433 char tmp
[64]; /* fastes packet size for usb controller */
434 int send_bits
, bufindex
= 0, fillindex
= 0, i
, loops
;
437 /* 61 byte can be transfered (488 bit) */
454 tmp
[0] = WRITE_AND_READ
;
455 tmp
[1] = (char)(send_bits
>> 8); /* high */
456 tmp
[2] = (char)(send_bits
); /* low */
459 for (i
= 0; i
< loops
; i
++)
461 tmp
[3 + i
] = buffer
[bufindex
];
465 if (usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 64, 1000) == 64)
467 /* LOG_INFO("HALLLLOOO2 %i",(int)tmp[0]); */
470 while (usb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, tmp
, 64, 1000) < 1)
477 for (i
= 0; i
< loops
; i
++)
480 buffer
[fillindex
++] = swap
;
486 static void usbprog_jtag_read_tdo(struct usbprog_jtag
*usbprog_jtag
, char * buffer
, int size
)
488 char tmp
[64]; /* fastes packet size for usb controller */
489 int send_bits
, fillindex
= 0, i
, loops
;
492 /* 61 byte can be transfered (488 bit) */
509 tmp
[0] = WRITE_AND_READ
;
510 tmp
[1] = (char)(send_bits
>> 8); /* high */
511 tmp
[2] = (char)(send_bits
); /* low */
513 usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 3, 1000);
515 /* LOG_INFO("HALLLLOOO3 %i",(int)tmp[0]); */
518 while (usb_bulk_read(usbprog_jtag
->usb_handle
, 0x82, tmp
, 64, 10) < 1)
525 for (i
= 0; i
< loops
; i
++)
528 buffer
[fillindex
++] = swap
;
533 static void usbprog_jtag_write_tdi(struct usbprog_jtag
*usbprog_jtag
, char * buffer
, int size
)
535 char tmp
[64]; /* fastes packet size for usb controller */
536 int send_bits
, bufindex
= 0, i
, loops
;
538 /* 61 byte can be transfered (488 bit) */
551 /* if (loops == 0) */
556 tmp
[1] = (char)(send_bits
>> 8); /* high */
557 tmp
[2] = (char)(send_bits
); /* low */
560 for (i
= 0; i
< loops
; i
++)
562 tmp
[3 + i
] = buffer
[bufindex
];
565 usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, 64, 1000);
569 static void usbprog_jtag_write_tms(struct usbprog_jtag
*usbprog_jtag
, char tms_scan
)
571 usbprog_jtag_tms_collect(tms_scan
);
574 static void usbprog_jtag_set_direction(struct usbprog_jtag
*usbprog_jtag
, unsigned char direction
)
577 tmp
[0] = PORT_DIRECTION
;
578 tmp
[1] = (char)direction
;
579 usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
582 static void usbprog_jtag_write_slice(struct usbprog_jtag
*usbprog_jtag
,unsigned char value
)
586 tmp
[1] = (char)value
;
587 usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
591 static unsigned char usbprog_jtag_get_port(struct usbprog_jtag
*usbprog_jtag
)
596 return usbprog_jtag_message(usbprog_jtag
, tmp
, 2);
600 static void usbprog_jtag_set_bit(struct usbprog_jtag
*usbprog_jtag
,int bit
, int value
)
603 tmp
[0] = PORT_SETBIT
;
609 usbprog_jtag_message(usbprog_jtag
, tmp
, 3);
613 static int usbprog_jtag_get_bit(struct usbprog_jtag
*usbprog_jtag
, int bit
)
616 tmp
[0] = PORT_GETBIT
;
619 if (usbprog_jtag_message(usbprog_jtag
, tmp
, 2) > 0)
626 static void usbprog_jtag_tms_collect(char tms_scan
)
628 tms_chain
[tms_chain_index
] = tms_scan
;
632 static void usbprog_jtag_tms_send(struct usbprog_jtag
*usbprog_jtag
)
635 /* LOG_INFO("TMS SEND"); */
636 if (tms_chain_index
> 0)
638 char tmp
[tms_chain_index
+ 2];
639 tmp
[0] = WRITE_TMS_CHAIN
;
640 tmp
[1] = (char)(tms_chain_index
);
641 for (i
= 0; i
< tms_chain_index
+ 1; i
++)
642 tmp
[2 + i
] = tms_chain
[i
];
643 usb_bulk_write(usbprog_jtag
->usb_handle
, 3, tmp
, tms_chain_index
+ 2, 1000);
648 struct jtag_interface usbprog_interface
= {
651 .execute_queue
= usbprog_execute_queue
,
652 .speed
= usbprog_speed
,
653 .init
= usbprog_init
,
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)