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, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
25 #include "interface.h"
28 #include "usb_common.h"
31 #define USB_VID 0x15ba
32 #define USB_PID 0x001e
34 #define ARMJTAGEW_EPT_BULK_OUT 0x01u
35 #define ARMJTAGEW_EPT_BULK_IN 0x82u
37 #define ARMJTAGEW_USB_TIMEOUT 2000
39 #define ARMJTAGEW_IN_BUFFER_SIZE (4*1024)
40 #define ARMJTAGEW_OUT_BUFFER_SIZE (4*1024)
43 /* USB command request codes. */
44 #define CMD_GET_VERSION 0x00
45 #define CMD_SELECT_DPIMPL 0x10
46 #define CMD_SET_TCK_FREQUENCY 0x11
47 #define CMD_GET_TCK_FREQUENCY 0x12
48 #define CMD_MEASURE_MAX_TCK_FREQ 0x15
49 #define CMD_MEASURE_RTCK_RESPONSE 0x16
50 #define CMD_TAP_SHIFT 0x17
51 #define CMD_SET_TAPHW_STATE 0x20
52 #define CMD_GET_TAPHW_STATE 0x21
53 #define CMD_TGPWR_SETUP 0x22
55 /* Global USB buffers */
56 static uint8_t usb_in_buffer[ARMJTAGEW_IN_BUFFER_SIZE];
57 static uint8_t usb_out_buffer[ARMJTAGEW_OUT_BUFFER_SIZE];
59 /* Queue command functions */
60 static void armjtagew_end_state(tap_state_t state);
61 static void armjtagew_state_move(void);
62 static void armjtagew_path_move(int num_states, tap_state_t *path);
63 static void armjtagew_runtest(int num_cycles);
64 static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, 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;
98 /***************************************************************************/
99 /* External interface implementation */
101 static int armjtagew_execute_queue(void)
103 struct jtag_command *cmd = jtag_command_queue;
113 DEBUG_JTAG_IO("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, \
114 cmd->cmd.runtest->end_state);
116 armjtagew_end_state(cmd->cmd.runtest->end_state);
117 armjtagew_runtest(cmd->cmd.runtest->num_cycles);
121 DEBUG_JTAG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
123 armjtagew_end_state(cmd->cmd.statemove->end_state);
124 armjtagew_state_move();
128 DEBUG_JTAG_IO("pathmove: %i states, end in %i", \
129 cmd->cmd.pathmove->num_states, \
130 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
132 armjtagew_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
136 DEBUG_JTAG_IO("scan end in %i", cmd->cmd.scan->end_state);
138 armjtagew_end_state(cmd->cmd.scan->end_state);
140 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
141 DEBUG_JTAG_IO("scan input, length = %d", scan_size);
143 #ifdef _DEBUG_USB_COMMS_
144 armjtagew_debug_buffer(buffer, (scan_size + 7) / 8);
146 type = jtag_scan_type(cmd->cmd.scan);
147 armjtagew_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size, cmd->cmd.scan);
151 DEBUG_JTAG_IO("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
153 armjtagew_tap_execute();
155 if (cmd->cmd.reset->trst == 1)
157 tap_set_state(TAP_RESET);
159 armjtagew_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
163 DEBUG_JTAG_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();
179 /* Sets speed in kHz. */
180 static int armjtagew_speed(int speed)
186 usb_out_buffer[0] = CMD_SET_TCK_FREQUENCY;
187 buf_set_u32(usb_out_buffer + 1, 0, 32, speed);
189 result = armjtagew_usb_message(armjtagew_handle, 4, 4);
193 LOG_ERROR("ARM-JTAG-EW setting speed failed (%d)", result);
194 return ERROR_JTAG_DEVICE_ERROR;
197 usb_out_buffer[0] = CMD_GET_TCK_FREQUENCY;
198 result = armjtagew_usb_message(armjtagew_handle, 1, 4);
199 speed_real = (int)buf_get_u32(usb_in_buffer,0,32);
202 LOG_ERROR("ARM-JTAG-EW getting speed failed (%d)", result);
203 return ERROR_JTAG_DEVICE_ERROR;
207 LOG_INFO("Requested speed %dkHz, emulator reported %dkHz.", speed, speed_real);
214 static int armjtagew_khz(int khz, int *jtag_speed)
221 static int armjtagew_init(void)
225 armjtagew_handle = armjtagew_usb_open();
227 if (armjtagew_handle == 0)
229 LOG_ERROR("Cannot find ARM-JTAG-EW Interface! Please check connection and permissions.");
230 return ERROR_JTAG_INIT_FAILED;
234 while (check_cnt < 3)
236 if (armjtagew_get_version_info() == ERROR_OK)
238 /* attempt to get status */
239 armjtagew_get_status();
248 LOG_INFO("ARM-JTAG-EW initial read failed, don't worry");
251 LOG_INFO("ARM-JTAG-EW JTAG Interface ready");
253 armjtagew_reset(0, 0);
254 armjtagew_tap_init();
259 static int armjtagew_quit(void)
261 armjtagew_usb_close(armjtagew_handle);
265 /***************************************************************************/
266 /* Queue command implementations */
268 static void armjtagew_end_state(tap_state_t state)
270 if (tap_is_state_stable(state))
272 tap_set_end_state(state);
276 LOG_ERROR("BUG: %i is not a valid end state", state);
281 /* Goes to the end state. */
282 static void armjtagew_state_move(void)
286 uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
287 int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
289 for (i = 0; i < tms_count; i++)
291 tms = (tms_scan >> i) & 1;
292 armjtagew_tap_append_step(tms, 0);
295 tap_set_state(tap_get_end_state());
298 static void armjtagew_path_move(int num_states, tap_state_t *path)
302 for (i = 0; i < num_states; i++)
305 * TODO: The ARM-JTAG-EW hardware delays TDI with 3 TCK cycles when in RTCK mode.
306 * Either handle that here, or update the documentation with examples
307 * how to fix that in the configuration files.
309 if (path[i] == tap_state_transition(tap_get_state(), false))
311 armjtagew_tap_append_step(0, 0);
313 else if (path[i] == tap_state_transition(tap_get_state(), true))
315 armjtagew_tap_append_step(1, 0);
319 LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(path[i]));
323 tap_set_state(path[i]);
326 tap_set_end_state(tap_get_state());
329 static void armjtagew_runtest(int num_cycles)
333 tap_state_t saved_end_state = tap_get_end_state();
335 /* only do a state_move when we're not already in IDLE */
336 if (tap_get_state() != TAP_IDLE)
338 armjtagew_end_state(TAP_IDLE);
339 armjtagew_state_move();
342 /* execute num_cycles */
343 for (i = 0; i < num_cycles; i++)
345 armjtagew_tap_append_step(0, 0);
348 /* finish in end_state */
349 armjtagew_end_state(saved_end_state);
350 if (tap_get_state() != tap_get_end_state())
352 armjtagew_state_move();
356 static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command)
358 tap_state_t saved_end_state;
360 armjtagew_tap_ensure_space(1, scan_size + 8);
362 saved_end_state = tap_get_end_state();
364 /* Move to appropriate scan state */
365 armjtagew_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
367 armjtagew_state_move();
368 armjtagew_end_state(saved_end_state);
371 armjtagew_tap_append_scan(scan_size, buffer, command);
373 /* We are in Exit1, go to Pause */
374 armjtagew_tap_append_step(0, 0);
376 tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
378 if (tap_get_state() != tap_get_end_state())
380 armjtagew_state_move();
384 static void armjtagew_reset(int trst, int srst)
386 const uint8_t trst_mask = (1u << 5);
387 const uint8_t srst_mask = (1u << 6);
390 uint8_t change_mask = 0;
393 LOG_DEBUG("trst: %i, srst: %i", trst, srst);
398 outp_en &= ~srst_mask; /* tristate */
399 change_mask |= srst_mask;
404 outp_en |= srst_mask;
405 change_mask |= srst_mask;
411 outp_en &= ~trst_mask; /* tristate */
412 change_mask |= trst_mask;
417 outp_en |= trst_mask;
418 change_mask |= trst_mask;
421 usb_out_buffer[0] = CMD_SET_TAPHW_STATE;
422 usb_out_buffer[1] = val;
423 usb_out_buffer[2] = outp_en;
424 usb_out_buffer[3] = change_mask;
425 result = armjtagew_usb_write(armjtagew_handle, 4);
428 LOG_ERROR("ARM-JTAG-EW TRST/SRST pin set failed failed (%d)", result);
433 static int armjtagew_get_status(void)
437 usb_out_buffer[0] = CMD_GET_TAPHW_STATE;
438 result = armjtagew_usb_message(armjtagew_handle, 1, 12);
442 unsigned int u_tg = buf_get_u32(usb_in_buffer, 0, 16);
443 LOG_INFO("U_tg = %d mV, U_aux = %d mV, U_tgpwr = %d mV, I_tgpwr = %d mA, D1 = %d, Target power %s %s\n",
444 (int)(buf_get_u32(usb_in_buffer + 0, 0, 16)),
445 (int)(buf_get_u32(usb_in_buffer + 2, 0, 16)),
446 (int)(buf_get_u32(usb_in_buffer + 4, 0, 16)),
447 (int)(buf_get_u32(usb_in_buffer + 6, 0, 16)),
449 usb_in_buffer[11] ? "OVERCURRENT" : "OK",
450 usb_in_buffer[10] ? "enabled" : "disabled");
454 LOG_ERROR("Vref too low. Check Target Power\n");
459 LOG_ERROR("ARM-JTAG-EW command CMD_GET_TAPHW_STATE failed (%d)\n", result);
465 static int armjtagew_get_version_info(void)
471 /* query hardware version */
472 usb_out_buffer[0] = CMD_GET_VERSION;
473 result = armjtagew_usb_message(armjtagew_handle, 1, 4 + 15 + 256);
477 LOG_ERROR("ARM-JTAG-EW command CMD_GET_VERSION failed (%d)\n", result);
478 return ERROR_JTAG_DEVICE_ERROR;
482 memcpy(sn, usb_in_buffer + 4, 15);
484 memcpy(auxinfo, usb_in_buffer + 4+15, 256);
487 LOG_INFO("ARM-JTAG-EW firmware version %d.%d, hardware revision %c, SN=%s, Additional info: %s", \
488 usb_in_buffer[1], usb_in_buffer[0], \
489 isgraph(usb_in_buffer[2]) ? usb_in_buffer[2] : 'X', \
494 COMMAND_HANDLER(armjtagew_handle_armjtagew_info_command)
496 if (armjtagew_get_version_info() == ERROR_OK)
498 /* attempt to get status */
499 armjtagew_get_status();
505 static int armjtagew_register_commands(struct command_context *cmd_ctx)
507 COMMAND_REGISTER(cmd_ctx, NULL, "armjtagew_info",
508 &armjtagew_handle_armjtagew_info_command, COMMAND_EXEC,
509 "query armjtagew info");
513 struct jtag_interface armjtagew_interface = {
514 .name = "arm-jtag-ew",
515 .execute_queue = &armjtagew_execute_queue,
516 .speed = &armjtagew_speed,
517 .khz = &armjtagew_khz,
518 .register_commands = &armjtagew_register_commands,
519 .init = &armjtagew_init,
520 .quit = &armjtagew_quit,
523 /***************************************************************************/
524 /* ARM-JTAG-EW tap functions */
526 /* 2048 is the max value we can use here */
527 #define ARMJTAGEW_TAP_BUFFER_SIZE 2048
529 static int tap_length;
530 static uint8_t tms_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
531 static uint8_t tdi_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
532 static uint8_t tdo_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
534 struct pending_scan_result {
535 int first; /* First bit position in tdo_buffer to read */
536 int length; /* Number of bits to read */
537 struct scan_command *command; /* Corresponding scan command */
541 #define MAX_PENDING_SCAN_RESULTS 256
543 static int pending_scan_results_length;
544 static struct pending_scan_result pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
548 static void armjtagew_tap_init(void)
551 pending_scan_results_length = 0;
554 static void armjtagew_tap_ensure_space(int scans, int bits)
556 int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
557 int available_bits = ARMJTAGEW_TAP_BUFFER_SIZE * 8 - tap_length;
559 if (scans > available_scans || bits > available_bits)
561 armjtagew_tap_execute();
565 static void armjtagew_tap_append_step(int tms, int tdi)
568 int index = tap_length / 8;
570 if (index < ARMJTAGEW_TAP_BUFFER_SIZE)
572 int bit_index = tap_length % 8;
573 uint8_t bit = 1 << bit_index;
577 tms_buffer[index] |= bit;
581 tms_buffer[index] &= ~bit;
586 tdi_buffer[index] |= bit;
590 tdi_buffer[index] &= ~bit;
597 LOG_ERROR("armjtagew_tap_append_step, overflow");
601 void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command)
603 struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
606 pending_scan_result->first = tap_length;
607 pending_scan_result->length = length;
608 pending_scan_result->command = command;
609 pending_scan_result->buffer = buffer;
611 for (i = 0; i < length; i++)
613 armjtagew_tap_append_step((i < length-1 ? 0 : 1), (buffer[i/8] >> (i%8)) & 1);
615 pending_scan_results_length++;
618 /* Pad and send a tap sequence to the device, and receive the answer.
619 * For the purpose of padding we assume that we are in idle or pause state. */
620 static int armjtagew_tap_execute(void)
630 /* Pad last byte so that tap_length is divisible by 8 */
631 while (tap_length % 8 != 0)
633 /* More of the last TMS value keeps us in the same state,
634 * analogous to free-running JTAG interfaces. */
635 armjtagew_tap_append_step(last_tms, 0);
638 byte_length = tap_length / 8;
640 usb_out_buffer[0] = CMD_TAP_SHIFT;
641 buf_set_u32(usb_out_buffer + 1, 0, 16, byte_length);
644 for (i = 0; i < byte_length; i++)
646 usb_out_buffer[tms_offset + i] = flip_u32(tms_buffer[i],8);
649 tdi_offset = tms_offset + byte_length;
650 for (i = 0; i < byte_length; i++)
652 usb_out_buffer[tdi_offset + i] = flip_u32(tdi_buffer[i],8);
655 result = armjtagew_usb_message(armjtagew_handle, 3 + 2 * byte_length, byte_length + 4);
661 stat = (int)buf_get_u32(usb_in_buffer + byte_length, 0, 32);
663 LOG_ERROR("armjtagew_tap_execute, emulator returned error code %d for a CMD_TAP_SHIFT command", stat);
664 return ERROR_JTAG_QUEUE_FAILED;
667 for (i = 0; i < byte_length; i++)
669 tdo_buffer[i] = flip_u32(usb_in_buffer[i],8);
672 for (i = 0; i < pending_scan_results_length; i++)
674 struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[i];
675 uint8_t *buffer = pending_scan_result->buffer;
676 int length = pending_scan_result->length;
677 int first = pending_scan_result->first;
678 struct scan_command *command = pending_scan_result->command;
681 buf_set_buf(tdo_buffer, first, buffer, 0, length);
683 DEBUG_JTAG_IO("pending scan result, length = %d", length);
685 #ifdef _DEBUG_USB_COMMS_
686 armjtagew_debug_buffer(buffer, byte_length);
689 if (jtag_read_buffer(buffer, command) != ERROR_OK)
691 armjtagew_tap_init();
692 return ERROR_JTAG_QUEUE_FAILED;
695 if (pending_scan_result->buffer != NULL)
697 free(pending_scan_result->buffer);
703 LOG_ERROR("armjtagew_tap_execute, wrong result %d, expected %d", result, byte_length);
704 return ERROR_JTAG_QUEUE_FAILED;
707 armjtagew_tap_init();
713 /*****************************************************************************/
714 /* JLink USB low-level functions */
716 static struct armjtagew* armjtagew_usb_open()
720 const uint16_t vids[] = { USB_VID, 0 };
721 const uint16_t pids[] = { USB_PID, 0 };
722 struct usb_dev_handle *dev;
723 if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
726 struct armjtagew *result = malloc(sizeof(struct armjtagew));
727 result->usb_handle = dev;
730 /* usb_set_configuration required under win32 */
731 usb_set_configuration(dev, dev->config[0].bConfigurationValue);
733 usb_claim_interface(dev, 0);
736 * This makes problems under Mac OS X. And is not needed
737 * under Windows. Hopefully this will not break a linux build
739 usb_set_altinterface(dev, 0);
744 static void armjtagew_usb_close(struct armjtagew *armjtagew)
746 usb_close(armjtagew->usb_handle);
750 /* Send a message and receive the reply. */
751 static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, int in_length)
755 result = armjtagew_usb_write(armjtagew, out_length);
756 if (result == out_length)
758 result = armjtagew_usb_read(armjtagew, in_length);
759 if (result != in_length)
761 LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)", in_length, result);
767 LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result);
773 /* Write data from out_buffer to USB. */
774 static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length)
778 if (out_length > ARMJTAGEW_OUT_BUFFER_SIZE)
780 LOG_ERROR("armjtagew_write illegal out_length=%d (max=%d)", out_length, ARMJTAGEW_OUT_BUFFER_SIZE);
784 result = usb_bulk_write(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_OUT, \
785 (char*)usb_out_buffer, out_length, ARMJTAGEW_USB_TIMEOUT);
787 DEBUG_JTAG_IO("armjtagew_usb_write, out_length = %d, result = %d", out_length, result);
789 #ifdef _DEBUG_USB_COMMS_
790 armjtagew_debug_buffer(usb_out_buffer, out_length);
795 /* Read data from USB into in_buffer. */
796 static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length)
798 int result = usb_bulk_read(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_IN, \
799 (char*)usb_in_buffer, exp_in_length, ARMJTAGEW_USB_TIMEOUT);
801 DEBUG_JTAG_IO("armjtagew_usb_read, result = %d", result);
803 #ifdef _DEBUG_USB_COMMS_
804 armjtagew_debug_buffer(usb_in_buffer, result);
810 #ifdef _DEBUG_USB_COMMS_
811 #define BYTES_PER_LINE 16
813 static void armjtagew_debug_buffer(uint8_t *buffer, int length)
820 for (i = 0; i < length; i += BYTES_PER_LINE)
822 snprintf(line, 5, "%04x", i);
823 for (j = i; j < i + BYTES_PER_LINE && j < length; j++)
825 snprintf(s, 4, " %02x", buffer[j]);
828 LOG_DEBUG("%s", line);