1 /***************************************************************************
2 * Copyright (C) 2009 by Dimitar Dimitrov <dinuxbg@gmail.com> *
3 * based on Dominic Rath's and Benedikt Sauter's usbprog.c *
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, see <http://www.gnu.org/licenses/>. *
17 ***************************************************************************/
23 #include <jtag/interface.h>
24 #include <jtag/commands.h>
26 #include "usb_common.h"
28 #define USB_VID 0x15ba
29 #define USB_PID 0x001e
31 #define ARMJTAGEW_EPT_BULK_OUT 0x01u
32 #define ARMJTAGEW_EPT_BULK_IN 0x82u
34 #define ARMJTAGEW_USB_TIMEOUT 2000
36 #define ARMJTAGEW_IN_BUFFER_SIZE (4*1024)
37 #define ARMJTAGEW_OUT_BUFFER_SIZE (4*1024)
39 /* USB command request codes. */
40 #define CMD_GET_VERSION 0x00
41 #define CMD_SELECT_DPIMPL 0x10
42 #define CMD_SET_TCK_FREQUENCY 0x11
43 #define CMD_GET_TCK_FREQUENCY 0x12
44 #define CMD_MEASURE_MAX_TCK_FREQ 0x15
45 #define CMD_MEASURE_RTCK_RESPONSE 0x16
46 #define CMD_TAP_SHIFT 0x17
47 #define CMD_SET_TAPHW_STATE 0x20
48 #define CMD_GET_TAPHW_STATE 0x21
49 #define CMD_TGPWR_SETUP 0x22
51 /* Global USB buffers */
52 static uint8_t usb_in_buffer[ARMJTAGEW_IN_BUFFER_SIZE];
53 static uint8_t usb_out_buffer[ARMJTAGEW_OUT_BUFFER_SIZE];
55 /* Queue command functions */
56 static void armjtagew_end_state(tap_state_t state);
57 static void armjtagew_state_move(void);
58 static void armjtagew_path_move(int num_states, tap_state_t *path);
59 static void armjtagew_runtest(int num_cycles);
60 static void armjtagew_scan(bool ir_scan,
64 struct scan_command *command);
65 static void armjtagew_reset(int trst, int srst);
66 /* static void armjtagew_simple_command(uint8_t command); */
67 static int armjtagew_get_status(void);
69 /* tap buffer functions */
70 static void armjtagew_tap_init(void);
71 static int armjtagew_tap_execute(void);
72 static void armjtagew_tap_ensure_space(int scans, int bits);
73 static void armjtagew_tap_append_step(int tms, int tdi);
74 static void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command);
76 /* ARM-JTAG-EW lowlevel functions */
78 struct usb_dev_handle *usb_handle;
81 static struct armjtagew *armjtagew_usb_open(void);
82 static void armjtagew_usb_close(struct armjtagew *armjtagew);
83 static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, int in_length);
84 static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length);
85 static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length);
87 /* helper functions */
88 static int armjtagew_get_version_info(void);
90 #ifdef _DEBUG_USB_COMMS_
91 static void armjtagew_debug_buffer(uint8_t *buffer, int length);
94 static struct armjtagew *armjtagew_handle;
96 /**************************************************************************
97 * External interface implementation */
99 static int armjtagew_execute_queue(void)
101 struct jtag_command *cmd = jtag_command_queue;
106 while (cmd != NULL) {
109 LOG_DEBUG_IO("runtest %i cycles, end in %i",
110 cmd->cmd.runtest->num_cycles, \
111 cmd->cmd.runtest->end_state);
113 armjtagew_end_state(cmd->cmd.runtest->end_state);
114 armjtagew_runtest(cmd->cmd.runtest->num_cycles);
118 LOG_DEBUG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
120 armjtagew_end_state(cmd->cmd.statemove->end_state);
121 armjtagew_state_move();
125 LOG_DEBUG_IO("pathmove: %i states, end in %i", \
126 cmd->cmd.pathmove->num_states, \
127 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
129 armjtagew_path_move(cmd->cmd.pathmove->num_states,
130 cmd->cmd.pathmove->path);
134 LOG_DEBUG_IO("scan end in %i", cmd->cmd.scan->end_state);
136 armjtagew_end_state(cmd->cmd.scan->end_state);
138 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
139 LOG_DEBUG_IO("scan input, length = %d", scan_size);
141 #ifdef _DEBUG_USB_COMMS_
142 armjtagew_debug_buffer(buffer, (scan_size + 7) / 8);
144 type = jtag_scan_type(cmd->cmd.scan);
145 armjtagew_scan(cmd->cmd.scan->ir_scan,
147 scan_size, cmd->cmd.scan);
151 LOG_DEBUG_IO("reset trst: %i srst %i",
152 cmd->cmd.reset->trst,
153 cmd->cmd.reset->srst);
155 armjtagew_tap_execute();
157 if (cmd->cmd.reset->trst == 1)
158 tap_set_state(TAP_RESET);
159 armjtagew_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
163 LOG_DEBUG_IO("sleep %i", cmd->cmd.sleep->us);
164 armjtagew_tap_execute();
165 jtag_sleep(cmd->cmd.sleep->us);
169 LOG_ERROR("BUG: unknown JTAG command type encountered");
175 return armjtagew_tap_execute();
178 /* Sets speed in kHz. */
179 static int armjtagew_speed(int speed)
185 usb_out_buffer[0] = CMD_SET_TCK_FREQUENCY;
186 buf_set_u32(usb_out_buffer + 1, 0, 32, speed*1000);
188 result = armjtagew_usb_message(armjtagew_handle, 5, 4);
191 LOG_ERROR("ARM-JTAG-EW setting speed failed (%d)", result);
192 return ERROR_JTAG_DEVICE_ERROR;
195 usb_out_buffer[0] = CMD_GET_TCK_FREQUENCY;
196 result = armjtagew_usb_message(armjtagew_handle, 1, 4);
197 speed_real = (int)buf_get_u32(usb_in_buffer, 0, 32) / 1000;
199 LOG_ERROR("ARM-JTAG-EW getting speed failed (%d)", result);
200 return ERROR_JTAG_DEVICE_ERROR;
202 LOG_INFO("Requested speed %dkHz, emulator reported %dkHz.", speed, speed_real);
207 static int armjtagew_khz(int khz, int *jtag_speed)
214 static int armjtagew_speed_div(int speed, int *khz)
221 static int armjtagew_init(void)
225 armjtagew_handle = armjtagew_usb_open();
227 if (armjtagew_handle == 0) {
229 "Cannot find ARM-JTAG-EW Interface! Please check connection and permissions.");
230 return ERROR_JTAG_INIT_FAILED;
234 while (check_cnt < 3) {
235 if (armjtagew_get_version_info() == ERROR_OK) {
236 /* attempt to get status */
237 armjtagew_get_status();
245 LOG_INFO("ARM-JTAG-EW initial read failed, don't worry");
247 /* Initial JTAG speed (for reset and initialization): 32 kHz */
250 LOG_INFO("ARM-JTAG-EW JTAG Interface ready");
252 armjtagew_reset(0, 0);
253 armjtagew_tap_init();
258 static int armjtagew_quit(void)
260 armjtagew_usb_close(armjtagew_handle);
264 /**************************************************************************
265 * Queue command implementations */
267 static void armjtagew_end_state(tap_state_t state)
269 if (tap_is_state_stable(state))
270 tap_set_end_state(state);
272 LOG_ERROR("BUG: %i is not a valid end state", state);
277 /* Goes to the end state. */
278 static void armjtagew_state_move(void)
282 uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
283 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
285 for (i = 0; i < tms_count; i++) {
286 tms = (tms_scan >> i) & 1;
287 armjtagew_tap_append_step(tms, 0);
290 tap_set_state(tap_get_end_state());
293 static void armjtagew_path_move(int num_states, tap_state_t *path)
297 for (i = 0; i < num_states; i++) {
299 * TODO: The ARM-JTAG-EW hardware delays TDI with 3 TCK cycles when in RTCK mode.
300 * Either handle that here, or update the documentation with examples
301 * how to fix that in the configuration files.
303 if (path[i] == tap_state_transition(tap_get_state(), false))
304 armjtagew_tap_append_step(0, 0);
305 else if (path[i] == tap_state_transition(tap_get_state(), true))
306 armjtagew_tap_append_step(1, 0);
308 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
309 tap_state_name(tap_get_state()), tap_state_name(path[i]));
313 tap_set_state(path[i]);
316 tap_set_end_state(tap_get_state());
319 static void armjtagew_runtest(int num_cycles)
323 tap_state_t saved_end_state = tap_get_end_state();
325 /* only do a state_move when we're not already in IDLE */
326 if (tap_get_state() != TAP_IDLE) {
327 armjtagew_end_state(TAP_IDLE);
328 armjtagew_state_move();
331 /* execute num_cycles */
332 for (i = 0; i < num_cycles; i++)
333 armjtagew_tap_append_step(0, 0);
335 /* finish in end_state */
336 armjtagew_end_state(saved_end_state);
337 if (tap_get_state() != tap_get_end_state())
338 armjtagew_state_move();
341 static void armjtagew_scan(bool ir_scan,
345 struct scan_command *command)
347 tap_state_t saved_end_state;
349 armjtagew_tap_ensure_space(1, scan_size + 8);
351 saved_end_state = tap_get_end_state();
353 /* Move to appropriate scan state */
354 armjtagew_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
356 /* Only move if we're not already there */
357 if (tap_get_state() != tap_get_end_state())
358 armjtagew_state_move();
360 armjtagew_end_state(saved_end_state);
363 armjtagew_tap_append_scan(scan_size, buffer, command);
365 /* We are in Exit1, go to Pause */
366 armjtagew_tap_append_step(0, 0);
368 tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
370 if (tap_get_state() != tap_get_end_state())
371 armjtagew_state_move();
374 static void armjtagew_reset(int trst, int srst)
376 const uint8_t trst_mask = (1u << 5);
377 const uint8_t srst_mask = (1u << 6);
380 uint8_t change_mask = 0;
383 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
387 outp_en &= ~srst_mask; /* tristate */
388 change_mask |= srst_mask;
389 } else if (srst == 1) {
391 outp_en |= srst_mask;
392 change_mask |= srst_mask;
397 outp_en &= ~trst_mask; /* tristate */
398 change_mask |= trst_mask;
399 } else if (trst == 1) {
401 outp_en |= trst_mask;
402 change_mask |= trst_mask;
405 usb_out_buffer[0] = CMD_SET_TAPHW_STATE;
406 usb_out_buffer[1] = val;
407 usb_out_buffer[2] = outp_en;
408 usb_out_buffer[3] = change_mask;
409 result = armjtagew_usb_write(armjtagew_handle, 4);
411 LOG_ERROR("ARM-JTAG-EW TRST/SRST pin set failed failed (%d)", result);
414 static int armjtagew_get_status(void)
418 usb_out_buffer[0] = CMD_GET_TAPHW_STATE;
419 result = armjtagew_usb_message(armjtagew_handle, 1, 12);
422 unsigned int u_tg = buf_get_u32(usb_in_buffer, 0, 16);
424 "U_tg = %d mV, U_aux = %d mV, U_tgpwr = %d mV, I_tgpwr = %d mA, D1 = %d, Target power %s %s",
425 (int)(buf_get_u32(usb_in_buffer + 0, 0, 16)),
426 (int)(buf_get_u32(usb_in_buffer + 2, 0, 16)),
427 (int)(buf_get_u32(usb_in_buffer + 4, 0, 16)),
428 (int)(buf_get_u32(usb_in_buffer + 6, 0, 16)),
430 usb_in_buffer[11] ? "OVERCURRENT" : "OK",
431 usb_in_buffer[10] ? "enabled" : "disabled");
434 LOG_ERROR("Vref too low. Check Target Power");
436 LOG_ERROR("ARM-JTAG-EW command CMD_GET_TAPHW_STATE failed (%d)", result);
441 static int armjtagew_get_version_info(void)
447 /* query hardware version */
448 usb_out_buffer[0] = CMD_GET_VERSION;
449 result = armjtagew_usb_message(armjtagew_handle, 1, 4 + 15 + 256);
452 LOG_ERROR("ARM-JTAG-EW command CMD_GET_VERSION failed (%d)", result);
453 return ERROR_JTAG_DEVICE_ERROR;
456 memcpy(sn, usb_in_buffer + 4, 15);
458 memcpy(auxinfo, usb_in_buffer + 4+15, 256);
462 "ARM-JTAG-EW firmware version %d.%d, hardware revision %c, SN=%s, Additional info: %s", \
465 isgraph(usb_in_buffer[2]) ? usb_in_buffer[2] : 'X', \
469 if (1 != usb_in_buffer[1] || 6 != usb_in_buffer[0])
471 "ARM-JTAG-EW firmware version %d.%d is untested with this version of OpenOCD. You might experience unexpected behavior.",
477 COMMAND_HANDLER(armjtagew_handle_armjtagew_info_command)
479 if (armjtagew_get_version_info() == ERROR_OK) {
480 /* attempt to get status */
481 armjtagew_get_status();
487 static const struct command_registration armjtagew_command_handlers[] = {
489 .name = "armjtagew_info",
490 .handler = &armjtagew_handle_armjtagew_info_command,
491 .mode = COMMAND_EXEC,
492 .help = "query armjtagew info",
495 COMMAND_REGISTRATION_DONE
498 struct jtag_interface armjtagew_interface = {
499 .name = "arm-jtag-ew",
500 .commands = armjtagew_command_handlers,
501 .transports = jtag_only,
502 .execute_queue = armjtagew_execute_queue,
503 .speed = armjtagew_speed,
504 .speed_div = armjtagew_speed_div,
505 .khz = armjtagew_khz,
506 .init = armjtagew_init,
507 .quit = armjtagew_quit,
510 /**************************************************************************
511 * ARM-JTAG-EW tap functions */
513 /* 2048 is the max value we can use here */
514 #define ARMJTAGEW_TAP_BUFFER_SIZE 2048
516 static int tap_length;
517 static uint8_t tms_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
518 static uint8_t tdi_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
519 static uint8_t tdo_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
521 struct pending_scan_result {
522 int first; /* First bit position in tdo_buffer to read */
523 int length; /* Number of bits to read */
524 struct scan_command *command; /* Corresponding scan command */
528 #define MAX_PENDING_SCAN_RESULTS 256
530 static int pending_scan_results_length;
531 static struct pending_scan_result pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
535 static void armjtagew_tap_init(void)
538 pending_scan_results_length = 0;
541 static void armjtagew_tap_ensure_space(int scans, int bits)
543 int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
544 int available_bits = ARMJTAGEW_TAP_BUFFER_SIZE * 8 - tap_length;
546 if (scans > available_scans || bits > available_bits)
547 armjtagew_tap_execute();
550 static void armjtagew_tap_append_step(int tms, int tdi)
553 int index_local = tap_length / 8;
555 if (index_local < ARMJTAGEW_TAP_BUFFER_SIZE) {
556 int bit_index = tap_length % 8;
557 uint8_t bit = 1 << bit_index;
560 tms_buffer[index_local] |= bit;
562 tms_buffer[index_local] &= ~bit;
565 tdi_buffer[index_local] |= bit;
567 tdi_buffer[index_local] &= ~bit;
571 LOG_ERROR("armjtagew_tap_append_step, overflow");
574 void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command)
576 struct pending_scan_result *pending_scan_result =
577 &pending_scan_results_buffer[pending_scan_results_length];
580 pending_scan_result->first = tap_length;
581 pending_scan_result->length = length;
582 pending_scan_result->command = command;
583 pending_scan_result->buffer = buffer;
585 for (i = 0; i < length; i++)
586 armjtagew_tap_append_step((i < length-1 ? 0 : 1), (buffer[i/8] >> (i%8)) & 1);
587 pending_scan_results_length++;
590 /* Pad and send a tap sequence to the device, and receive the answer.
591 * For the purpose of padding we assume that we are in idle or pause state. */
592 static int armjtagew_tap_execute(void)
600 if (tap_length > 0) {
601 /* Pad last byte so that tap_length is divisible by 8 */
602 while (tap_length % 8 != 0) {
603 /* More of the last TMS value keeps us in the same state,
604 * analogous to free-running JTAG interfaces. */
605 armjtagew_tap_append_step(last_tms, 0);
608 byte_length = tap_length / 8;
610 usb_out_buffer[0] = CMD_TAP_SHIFT;
611 buf_set_u32(usb_out_buffer + 1, 0, 16, byte_length);
614 for (i = 0; i < byte_length; i++)
615 usb_out_buffer[tms_offset + i] = flip_u32(tms_buffer[i], 8);
617 tdi_offset = tms_offset + byte_length;
618 for (i = 0; i < byte_length; i++)
619 usb_out_buffer[tdi_offset + i] = flip_u32(tdi_buffer[i], 8);
621 result = armjtagew_usb_message(armjtagew_handle,
628 stat_local = (int)buf_get_u32(usb_in_buffer + byte_length, 0, 32);
631 "armjtagew_tap_execute, emulator returned error code %d for a CMD_TAP_SHIFT command",
633 return ERROR_JTAG_QUEUE_FAILED;
636 for (i = 0; i < byte_length; i++)
637 tdo_buffer[i] = flip_u32(usb_in_buffer[i], 8);
639 for (i = 0; i < pending_scan_results_length; i++) {
640 struct pending_scan_result *pending_scan_result =
641 &pending_scan_results_buffer[i];
642 uint8_t *buffer = pending_scan_result->buffer;
643 int length = pending_scan_result->length;
644 int first = pending_scan_result->first;
645 struct scan_command *command = pending_scan_result->command;
648 buf_set_buf(tdo_buffer, first, buffer, 0, length);
650 LOG_DEBUG_IO("pending scan result, length = %d", length);
652 #ifdef _DEBUG_USB_COMMS_
653 armjtagew_debug_buffer(buffer, byte_length);
656 if (jtag_read_buffer(buffer, command) != ERROR_OK) {
657 armjtagew_tap_init();
658 return ERROR_JTAG_QUEUE_FAILED;
661 if (pending_scan_result->buffer != NULL)
662 free(pending_scan_result->buffer);
665 LOG_ERROR("armjtagew_tap_execute, wrong result %d, expected %d",
668 return ERROR_JTAG_QUEUE_FAILED;
671 armjtagew_tap_init();
677 /****************************************************************************
678 * JLink USB low-level functions */
680 static struct armjtagew *armjtagew_usb_open()
684 const uint16_t vids[] = { USB_VID, 0 };
685 const uint16_t pids[] = { USB_PID, 0 };
686 struct usb_dev_handle *dev;
687 if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
690 struct armjtagew *result = malloc(sizeof(struct armjtagew));
691 result->usb_handle = dev;
694 /* usb_set_configuration required under win32 */
695 usb_set_configuration(dev, dev->config[0].bConfigurationValue);
697 usb_claim_interface(dev, 0);
700 * This makes problems under Mac OS X. And is not needed
701 * under Windows. Hopefully this will not break a linux build
703 usb_set_altinterface(dev, 0);
708 static void armjtagew_usb_close(struct armjtagew *armjtagew)
710 usb_close(armjtagew->usb_handle);
714 /* Send a message and receive the reply. */
715 static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, int in_length)
719 result = armjtagew_usb_write(armjtagew, out_length);
720 if (result == out_length) {
721 result = armjtagew_usb_read(armjtagew, in_length);
722 if (result != in_length) {
723 LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)",
729 LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result);
735 /* Write data from out_buffer to USB. */
736 static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length)
740 if (out_length > ARMJTAGEW_OUT_BUFFER_SIZE) {
741 LOG_ERROR("armjtagew_write illegal out_length=%d (max=%d)",
743 ARMJTAGEW_OUT_BUFFER_SIZE);
747 result = usb_bulk_write(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_OUT, \
748 (char *)usb_out_buffer, out_length, ARMJTAGEW_USB_TIMEOUT);
750 LOG_DEBUG_IO("armjtagew_usb_write, out_length = %d, result = %d", out_length, result);
752 #ifdef _DEBUG_USB_COMMS_
753 armjtagew_debug_buffer(usb_out_buffer, out_length);
758 /* Read data from USB into in_buffer. */
759 static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length)
761 int result = usb_bulk_read(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_IN, \
762 (char *)usb_in_buffer, exp_in_length, ARMJTAGEW_USB_TIMEOUT);
764 LOG_DEBUG_IO("armjtagew_usb_read, result = %d", result);
766 #ifdef _DEBUG_USB_COMMS_
767 armjtagew_debug_buffer(usb_in_buffer, result);
772 #ifdef _DEBUG_USB_COMMS_
773 #define BYTES_PER_LINE 16
775 static void armjtagew_debug_buffer(uint8_t *buffer, int length)
782 for (i = 0; i < length; i += BYTES_PER_LINE) {
783 snprintf(line, 5, "%04x", i);
784 for (j = i; j < i + BYTES_PER_LINE && j < length; j++) {
785 snprintf(s, 4, " %02x", buffer[j]);
788 LOG_DEBUG("%s", line);
790 /* Prevent GDB timeout (writing to log might take some time) */