git.gag.com Git - fw/openocd/blob - src/jtag/drivers/jlink.c

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Juergen Stuber <juergen@jstuber.net>            *
   3  *   based on Dominic Rath's and Benedikt Sauter's usbprog.c               *
   4  *                                                                         *
   5  *   Copyright (C) 2008 by Spencer Oliver                                  *
   6  *   spen@spen-soft.co.uk                                                  *
   7  *                                                                         *
   8  *   Copyright (C) 2011 by Jean-Christophe PLAGNIOL-VIILARD                *
   9  *   plagnioj@jcrosoft.com                                                 *
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  *   This program is distributed in the hope that it will be useful,       *
  17  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  18  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  19  *   GNU General Public License for more details.                          *
  20  *                                                                         *
  21  *   You should have received a copy of the GNU General Public License     *
  22  *   along with this program; if not, write to the                         *
  23  *   Free Software Foundation, Inc.,                                       *
  24  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  25  ***************************************************************************/
  26
  27 #ifdef HAVE_CONFIG_H
  28 #include "config.h"
  29 #endif
  30
  31 #include <jtag/interface.h>
  32 #include <jtag/commands.h>
  33 #include "usb_common.h"
  34
  35 /* See Segger's public documentation:
  36  *      Reference manual for J-Link USB Protocol
  37  *      Document RM08001-R6 Date: June 16, 2009
  38  *      (Or newer, with some SWD information).
  39
  40 http://www.segger.com/cms/admin/uploads/productDocs/RM08001_JLinkUSBProtocol.pdf
  41  */
  42
  43 /*
  44  * The default pid of the segger is 0x0101
  45  * But when you change the USB Address it will also
  46  *
  47  * pid = ( usb_address > 0x4) ? 0x0101 : (0x101 + usb_address)
  48  */
  49 #define VID 0x1366, 0x1366, 0x1366, 0x1366
  50 #define PID 0x0101, 0x0102, 0x0103, 0x0104
  51
  52 #define JLINK_WRITE_ENDPOINT    0x02
  53 #define JLINK_READ_ENDPOINT             0x81
  54
  55 static unsigned int jlink_write_ep = JLINK_WRITE_ENDPOINT;
  56 static unsigned int jlink_read_ep = JLINK_READ_ENDPOINT;
  57 static unsigned int jlink_hw_jtag_version = 2;
  58
  59 #define JLINK_USB_TIMEOUT               1000
  60
  61 // See Section 3.3.2 of the Segger JLink USB protocol manual
  62 /* 2048 is the max value we can use here */
  63 #define JLINK_TAP_BUFFER_SIZE 2048
  64 //#define JLINK_TAP_BUFFER_SIZE 256
  65 //#define JLINK_TAP_BUFFER_SIZE 384
  66
  67 #define JLINK_IN_BUFFER_SIZE                    2048
  68 #define JLINK_OUT_BUFFER_SIZE                   2*2048 + 4
  69 #define JLINK_EMU_RESULT_BUFFER_SIZE    64
  70
  71 /* Global USB buffers */
  72 static uint8_t usb_in_buffer[JLINK_IN_BUFFER_SIZE];
  73 static uint8_t usb_out_buffer[JLINK_OUT_BUFFER_SIZE];
  74 static uint8_t usb_emu_result_buffer[JLINK_EMU_RESULT_BUFFER_SIZE];
  75
  76 /* Constants for JLink command */
  77 #define EMU_CMD_VERSION                 0x01
  78 #define EMU_CMD_SET_SPEED               0x05
  79 #define EMU_CMD_GET_STATE               0x07
  80 #define EMU_CMD_HW_CLOCK                0xc8
  81 #define EMU_CMD_HW_TMS0                 0xc9
  82 #define EMU_CMD_HW_TMS1                 0xca
  83 #define EMU_CMD_HW_JTAG2                0xce
  84 #define EMU_CMD_HW_JTAG3                0xcf
  85 #define EMU_CMD_GET_MAX_MEM_BLOCK       0xd4
  86 #define EMU_CMD_HW_RESET0               0xdc
  87 #define EMU_CMD_HW_RESET1               0xdd
  88 #define EMU_CMD_HW_TRST0                0xde
  89 #define EMU_CMD_HW_TRST1                0xdf
  90 #define EMU_CMD_GET_CAPS                0xe8
  91 #define EMU_CMD_GET_HW_VERSION  0xf0
  92 #define EMU_CMD_READ_CONFIG             0xf2
  93 #define EMU_CMD_WRITE_CONFIG            0xf3
  94
  95 /* bits return from EMU_CMD_GET_CAPS */
  96 #define EMU_CAP_RESERVED_1              0
  97 #define EMU_CAP_GET_HW_VERSION          1
  98 #define EMU_CAP_WRITE_DCC               2
  99 #define EMU_CAP_ADAPTIVE_CLOCKING       3
 100 #define EMU_CAP_READ_CONFIG             4
 101 #define EMU_CAP_WRITE_CONFIG            5
 102 #define EMU_CAP_TRACE                   6
 103 #define EMU_CAP_WRITE_MEM               7
 104 #define EMU_CAP_READ_MEM                8
 105 #define EMU_CAP_SPEED_INFO              9
 106 #define EMU_CAP_EXEC_CODE               10
 107 #define EMU_CAP_GET_MAX_BLOCK_SIZE      11
 108 #define EMU_CAP_GET_HW_INFO             12
 109 #define EMU_CAP_SET_KS_POWER            13
 110 #define EMU_CAP_RESET_STOP_TIMED        14
 111 #define EMU_CAP_RESERVED_2              15
 112 #define EMU_CAP_MEASURE_RTCK_REACT      16
 113 #define EMU_CAP_SELECT_IF               17
 114 #define EMU_CAP_RW_MEM_ARM79            18
 115 #define EMU_CAP_GET_COUNTERS            19
 116 #define EMU_CAP_READ_DCC                20
 117 #define EMU_CAP_GET_CPU_CAPS            21
 118 #define EMU_CAP_EXEC_CPU_CMD            22
 119 #define EMU_CAP_SWO                     23
 120 #define EMU_CAP_WRITE_DCC_EX            24
 121 #define EMU_CAP_UPDATE_FIRMWARE_EX      25
 122 #define EMU_CAP_FILE_IO                 26
 123 #define EMU_CAP_REGISTER                27
 124 #define EMU_CAP_INDICATORS              28
 125 #define EMU_CAP_TEST_NET_SPEED          29
 126 #define EMU_CAP_RAWTRACE                30
 127 #define EMU_CAP_RESERVED_3              31
 128
 129 static char *jlink_cap_str[] = {
 130         "Always 1.",
 131         "Supports command EMU_CMD_GET_HARDWARE_VERSION",
 132         "Supports command EMU_CMD_WRITE_DCC",
 133         "Supports adaptive clocking",
 134         "Supports command EMU_CMD_READ_CONFIG",
 135         "Supports command EMU_CMD_WRITE_CONFIG",
 136         "Supports trace commands",
 137         "Supports command EMU_CMD_WRITE_MEM",
 138         "Supports command EMU_CMD_READ_MEM",
 139         "Supports command EMU_CMD_GET_SPEED",
 140         "Supports command EMU_CMD_CODE_...",
 141         "Supports command EMU_CMD_GET_MAX_BLOCK_SIZE",
 142         "Supports command EMU_CMD_GET_HW_INFO",
 143         "Supports command EMU_CMD_SET_KS_POWER",
 144         "Supports command EMU_CMD_HW_RELEASE_RESET_STOP_TIMED",
 145         "Reserved",
 146         "Supports command EMU_CMD_MEASURE_RTCK_REACT",
 147         "Supports command EMU_CMD_HW_SELECT_IF",
 148         "Supports command EMU_CMD_READ/WRITE_MEM_ARM79",
 149         "Supports command EMU_CMD_GET_COUNTERS",
 150         "Supports command EMU_CMD_READ_DCC",
 151         "Supports command EMU_CMD_GET_CPU_CAPS",
 152         "Supports command EMU_CMD_EXEC_CPU_CMD",
 153         "Supports command EMU_CMD_SWO",
 154         "Supports command EMU_CMD_WRITE_DCC_EX",
 155         "Supports command EMU_CMD_UPDATE_FIRMWARE_EX",
 156         "Supports command EMU_CMD_FILE_IO",
 157         "Supports command EMU_CMD_REGISTER",
 158         "Supports command EMU_CMD_INDICATORS",
 159         "Supports command EMU_CMD_TEST_NET_SPEED",
 160         "Supports command EMU_CMD_RAWTRACE",
 161         "Reserved",
 162 };
 163
 164 /* max speed 12MHz v5.0 jlink */
 165 #define JLINK_MAX_SPEED 12000
 166
 167 /* J-Link hardware versions */
 168 #define JLINK_HW_TYPE_JLINK     0
 169 #define JLINK_HW_TYPE_JTRACE    1
 170 #define JLINK_HW_TYPE_FLASHER   2
 171 #define JLINK_HW_TYPE_JLINK_PRO 3
 172 #define JLINK_HW_TYPE_MAX       4
 173
 174 static char *jlink_hw_type_str[] = {
 175         "J-Link",
 176         "J-Trace",
 177         "Flasher",
 178         "J-Link Pro",
 179 };
 180
 181 /* Queue command functions */
 182 static void jlink_end_state(tap_state_t state);
 183 static void jlink_state_move(void);
 184 static void jlink_path_move(int num_states, tap_state_t *path);
 185 static void jlink_runtest(int num_cycles);
 186 static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer,
 187                 int scan_size, struct scan_command *command);
 188 static void jlink_reset(int trst, int srst);
 189 static void jlink_simple_command(uint8_t command);
 190 static int jlink_get_status(void);
 191
 192 /* J-Link tap buffer functions */
 193 static void jlink_tap_init(void);
 194 static int jlink_tap_execute(void);
 195 static void jlink_tap_ensure_space(int scans, int bits);
 196 static void jlink_tap_append_step(int tms, int tdi);
 197 static void jlink_tap_append_scan(int length, uint8_t *buffer,
 198                 struct scan_command *command);
 199
 200 /* Jlink lowlevel functions */
 201 struct jlink {
 202         struct usb_dev_handle* usb_handle;
 203 };
 204
 205 static struct jlink *jlink_usb_open(void);
 206 static void jlink_usb_close(struct jlink *jlink);
 207 static int jlink_usb_message(struct jlink *jlink, int out_length, int in_length);
 208 static int jlink_usb_write(struct jlink *jlink, int out_length);
 209 static int jlink_usb_read(struct jlink *jlink, int expected_size);
 210 static int jlink_usb_read_emu_result(struct jlink *jlink);
 211
 212 /* helper functions */
 213 static int jlink_get_version_info(void);
 214
 215 #ifdef _DEBUG_USB_COMMS_
 216 static void jlink_debug_buffer(uint8_t *buffer, int length);
 217 #else
 218 static inline void jlink_debug_buffer(uint8_t *buffer, int length)
 219 {
 220 }
 221 #endif
 222
 223 static enum tap_state jlink_last_state = TAP_RESET;
 224
 225 static struct jlink* jlink_handle;
 226
 227 /* pid could be specified at runtime */
 228 static uint16_t vids[] = { VID, 0 };
 229 static uint16_t pids[] = { PID, 0 };
 230
 231 static uint32_t jlink_caps;
 232 static uint32_t jlink_hw_type;
 233
 234 /* 256 byte non-volatile memory */
 235 struct jlink_config {
 236         uint8_t usb_address;
 237         /* 0ffset 0x01 to 0x03 */
 238         uint8_t reserved_1[3];
 239         uint32_t kickstart_power_on_jtag_pin_19;
 240         /* 0ffset 0x08 to 0x1f */
 241         uint8_t reserved_2[24];
 242         /* IP only for J-Link Pro */
 243         uint8_t ip_address[4];
 244         uint8_t subnet_mask[4];
 245         /* 0ffset 0x28 to 0x2f */
 246         uint8_t reserved_3[8];
 247         uint8_t mac_address[6];
 248         /* 0ffset 0x36 to 0xff */
 249         uint8_t reserved_4[202];
 250 } __attribute__ ((packed));
 251 struct jlink_config jlink_cfg;
 252
 253 /***************************************************************************/
 254 /* External interface implementation */
 255
 256 static void jlink_execute_runtest(struct jtag_command *cmd)
 257 {
 258         DEBUG_JTAG_IO("runtest %i cycles, end in %i",
 259                         cmd->cmd.runtest->num_cycles,
 260                         cmd->cmd.runtest->end_state);
 261
 262         jlink_end_state(cmd->cmd.runtest->end_state);
 263
 264         jlink_runtest(cmd->cmd.runtest->num_cycles);
 265 }
 266
 267 static void jlink_execute_statemove(struct jtag_command *cmd)
 268 {
 269         DEBUG_JTAG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
 270
 271         jlink_end_state(cmd->cmd.statemove->end_state);
 272         jlink_state_move();
 273 }
 274
 275 static void jlink_execute_pathmove(struct jtag_command *cmd)
 276 {
 277         DEBUG_JTAG_IO("pathmove: %i states, end in %i",
 278                 cmd->cmd.pathmove->num_states,
 279                 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
 280
 281         jlink_path_move(cmd->cmd.pathmove->num_states,
 282                         cmd->cmd.pathmove->path);
 283 }
 284
 285 static void jlink_execute_scan(struct jtag_command *cmd)
 286 {
 287         int scan_size;
 288         enum scan_type type;
 289         uint8_t *buffer;
 290
 291         DEBUG_JTAG_IO("scan end in %s", tap_state_name(cmd->cmd.scan->end_state));
 292
 293         jlink_end_state(cmd->cmd.scan->end_state);
 294
 295         scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
 296         DEBUG_JTAG_IO("scan input, length = %d", scan_size);
 297
 298         jlink_debug_buffer(buffer, (scan_size + 7) / 8);
 299         type = jtag_scan_type(cmd->cmd.scan);
 300         jlink_scan(cmd->cmd.scan->ir_scan,
 301                         type, buffer, scan_size, cmd->cmd.scan);
 302 }
 303
 304 static void jlink_execute_reset(struct jtag_command *cmd)
 305 {
 306         DEBUG_JTAG_IO("reset trst: %i srst %i",
 307                         cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 308
 309         jlink_tap_execute();
 310         jlink_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 311         jlink_tap_execute();
 312 }
 313
 314 static void jlink_execute_sleep(struct jtag_command *cmd)
 315 {
 316         DEBUG_JTAG_IO("sleep %" PRIi32 "", cmd->cmd.sleep->us);
 317         jlink_tap_execute();
 318         jtag_sleep(cmd->cmd.sleep->us);
 319 }
 320
 321 static void jlink_execute_command(struct jtag_command *cmd)
 322 {
 323         switch (cmd->type)
 324         {
 325         case JTAG_RUNTEST:   jlink_execute_runtest(cmd); break;
 326         case JTAG_TLR_RESET: jlink_execute_statemove(cmd); break;
 327         case JTAG_PATHMOVE:  jlink_execute_pathmove(cmd); break;
 328         case JTAG_SCAN:      jlink_execute_scan(cmd); break;
 329         case JTAG_RESET:     jlink_execute_reset(cmd); break;
 330         case JTAG_SLEEP:     jlink_execute_sleep(cmd); break;
 331         default:
 332                 LOG_ERROR("BUG: unknown JTAG command type encountered");
 333                 exit(-1);
 334         }
 335 }
 336
 337 static int jlink_execute_queue(void)
 338 {
 339         struct jtag_command *cmd = jtag_command_queue;
 340
 341         while (cmd != NULL)
 342         {
 343                 jlink_execute_command(cmd);
 344                 cmd = cmd->next;
 345         }
 346
 347         return jlink_tap_execute();
 348 }
 349
 350 /* Sets speed in kHz. */
 351 static int jlink_speed(int speed)
 352 {
 353         int result;
 354
 355         if (speed > JLINK_MAX_SPEED)
 356         {
 357                 LOG_INFO("reduce speed request: %dkHz to %dkHz maximum",
 358                                 speed, JLINK_MAX_SPEED);
 359                 speed = JLINK_MAX_SPEED;
 360         }
 361
 362         /* check for RTCK setting */
 363         if (speed == 0)
 364                 speed = -1;
 365
 366         usb_out_buffer[0] = EMU_CMD_SET_SPEED;
 367         usb_out_buffer[1] = (speed >> 0) & 0xff;
 368         usb_out_buffer[2] = (speed >> 8) & 0xff;
 369
 370         result = jlink_usb_write(jlink_handle, 3);
 371         if (result != 3)
 372         {
 373                 LOG_ERROR("J-Link setting speed failed (%d)", result);
 374                 return ERROR_JTAG_DEVICE_ERROR;
 375         }
 376
 377         return ERROR_OK;
 378 }
 379
 380 static int jlink_speed_div(int speed, int* khz)
 381 {
 382         *khz = speed;
 383
 384         return ERROR_OK;
 385 }
 386
 387 static int jlink_khz(int khz, int *jtag_speed)
 388 {
 389         *jtag_speed = khz;
 390
 391         return ERROR_OK;
 392 }
 393
 394 static int jlink_init(void)
 395 {
 396         int i;
 397
 398         jlink_handle = jlink_usb_open();
 399
 400         if (jlink_handle == 0)
 401         {
 402                 LOG_ERROR("Cannot find jlink Interface! Please check "
 403                                 "connection and permissions.");
 404                 return ERROR_JTAG_INIT_FAILED;
 405         }
 406
 407         /*
 408          * The next three instructions were added after discovering a problem
 409          * while using an oscilloscope.
 410          * For the V8 SAM-ICE dongle (and likely other j-link device variants),
 411          * the reset line to the target microprocessor was found to cycle only
 412          * intermittently during emulator startup (even after encountering the
 413          * downstream reset instruction later in the code).
 414          * This was found to create two issues:
 415          * 1) In general it is a bad practice to not reset a CPU to a known
 416          * state when starting an emulator and
 417          * 2) something critical happens inside the dongle when it does the
 418          * first read following a new USB session.
 419          * Keeping the processor in reset during the first read collecting
 420          * version information seems to prevent errant
 421          * "J-Link command EMU_CMD_VERSION failed" issues.
 422          */
 423
 424         LOG_INFO("J-Link initialization started / target CPU reset initiated");
 425         jlink_simple_command(EMU_CMD_HW_TRST0);
 426         jlink_simple_command(EMU_CMD_HW_RESET0);
 427         usleep(1000);
 428
 429         jlink_hw_jtag_version = 2;
 430
 431         if (jlink_get_version_info() == ERROR_OK)
 432         {
 433                 /* attempt to get status */
 434                 jlink_get_status();
 435         }
 436
 437         LOG_INFO("J-Link JTAG Interface ready");
 438
 439         jlink_reset(0, 0);
 440         jtag_sleep(3000);
 441         jlink_tap_init();
 442         int jtag_speed_var;
 443         int retval = jtag_get_speed(&jtag_speed_var);
 444         if (retval != ERROR_OK)
 445                 return retval;
 446         jlink_speed(jtag_speed_var);
 447
 448         /* v5/6 jlink seems to have an issue if the first tap move
 449          * is not divisible by 8, so we send a TLR on first power up */
 450         for (i = 0; i < 8; i++) {
 451                 jlink_tap_append_step(1, 0);
 452         }
 453         jlink_tap_execute();
 454
 455         return ERROR_OK;
 456 }
 457
 458 static int jlink_quit(void)
 459 {
 460         jlink_usb_close(jlink_handle);
 461         return ERROR_OK;
 462 }
 463
 464 /***************************************************************************/
 465 /* Queue command implementations */
 466
 467 static void jlink_end_state(tap_state_t state)
 468 {
 469         if (tap_is_state_stable(state))
 470         {
 471                 tap_set_end_state(state);
 472         }
 473         else
 474         {
 475                 LOG_ERROR("BUG: %i is not a valid end state", state);
 476                 exit(-1);
 477         }
 478 }
 479
 480 /* Goes to the end state. */
 481 static void jlink_state_move(void)
 482 {
 483         int i;
 484         int tms = 0;
 485         uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
 486         uint8_t tms_scan_bits = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
 487
 488         for (i = 0; i < tms_scan_bits; i++)
 489         {
 490                 tms = (tms_scan >> i) & 1;
 491                 jlink_tap_append_step(tms, 0);
 492         }
 493
 494         tap_set_state(tap_get_end_state());
 495 }
 496
 497 static void jlink_path_move(int num_states, tap_state_t *path)
 498 {
 499         int i;
 500
 501         for (i = 0; i < num_states; i++)
 502         {
 503                 if (path[i] == tap_state_transition(tap_get_state(), false))
 504                 {
 505                         jlink_tap_append_step(0, 0);
 506                 }
 507                 else if (path[i] == tap_state_transition(tap_get_state(), true))
 508                 {
 509                         jlink_tap_append_step(1, 0);
 510                 }
 511                 else
 512                 {
 513                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
 514                                         tap_state_name(tap_get_state()), tap_state_name(path[i]));
 515                         exit(-1);
 516                 }
 517
 518                 tap_set_state(path[i]);
 519         }
 520
 521         tap_set_end_state(tap_get_state());
 522 }
 523
 524 static void jlink_runtest(int num_cycles)
 525 {
 526         int i;
 527
 528         tap_state_t saved_end_state = tap_get_end_state();
 529
 530         jlink_tap_ensure_space(1,num_cycles + 16);
 531
 532         /* only do a state_move when we're not already in IDLE */
 533         if (tap_get_state() != TAP_IDLE)
 534         {
 535                 jlink_end_state(TAP_IDLE);
 536                 jlink_state_move();
 537 //              num_cycles--;
 538         }
 539
 540         /* execute num_cycles */
 541         for (i = 0; i < num_cycles; i++)
 542         {
 543                 jlink_tap_append_step(0, 0);
 544         }
 545
 546         /* finish in end_state */
 547         jlink_end_state(saved_end_state);
 548         if (tap_get_state() != tap_get_end_state())
 549         {
 550                 jlink_state_move();
 551         }
 552 }
 553
 554 static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer,
 555                 int scan_size, struct scan_command *command)
 556 {
 557         tap_state_t saved_end_state;
 558
 559         jlink_tap_ensure_space(1, scan_size + 16);
 560
 561         saved_end_state = tap_get_end_state();
 562
 563         /* Move to appropriate scan state */
 564         jlink_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
 565
 566         /* Only move if we're not already there */
 567         if (tap_get_state() != tap_get_end_state())
 568                 jlink_state_move();
 569
 570         jlink_end_state(saved_end_state);
 571
 572         /* Scan */
 573         jlink_tap_append_scan(scan_size, buffer, command);
 574
 575         /* We are in Exit1, go to Pause */
 576         jlink_tap_append_step(0, 0);
 577
 578         tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
 579
 580         if (tap_get_state() != tap_get_end_state())
 581         {
 582                 jlink_state_move();
 583         }
 584 }
 585
 586 static void jlink_reset(int trst, int srst)
 587 {
 588         LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 589
 590         /* Signals are active low */
 591         if (srst == 0)
 592         {
 593                 jlink_simple_command(EMU_CMD_HW_RESET1);
 594         }
 595         if (srst == 1)
 596         {
 597                 jlink_simple_command(EMU_CMD_HW_RESET0);
 598         }
 599
 600         if (trst == 1)
 601         {
 602                 jlink_simple_command(EMU_CMD_HW_TRST0);
 603         }
 604
 605         if (trst == 0)
 606         {
 607                 jlink_simple_command(EMU_CMD_HW_TRST1);
 608         }
 609 }
 610
 611 static void jlink_simple_command(uint8_t command)
 612 {
 613         int result;
 614
 615         DEBUG_JTAG_IO("0x%02x", command);
 616
 617         usb_out_buffer[0] = command;
 618         result = jlink_usb_write(jlink_handle, 1);
 619
 620         if (result != 1)
 621         {
 622                 LOG_ERROR("J-Link command 0x%02x failed (%d)", command, result);
 623         }
 624 }
 625
 626 static int jlink_get_status(void)
 627 {
 628         int result;
 629
 630         jlink_simple_command(EMU_CMD_GET_STATE);
 631
 632         result = jlink_usb_read(jlink_handle, 8);
 633         if (result != 8)
 634         {
 635                 LOG_ERROR("J-Link command EMU_CMD_GET_STATE failed (%d)", result);
 636                 return ERROR_JTAG_DEVICE_ERROR;
 637         }
 638
 639         int vref = usb_in_buffer[0] + (usb_in_buffer[1] << 8);
 640         LOG_INFO("Vref = %d.%d TCK = %d TDI = %d TDO = %d TMS = %d SRST = %d TRST = %d", \
 641                 vref / 1000, vref % 1000, \
 642                 usb_in_buffer[2], usb_in_buffer[3], usb_in_buffer[4], \
 643                 usb_in_buffer[5], usb_in_buffer[6], usb_in_buffer[7]);
 644
 645         if (vref < 1500)
 646                 LOG_ERROR("Vref too low. Check Target Power");
 647
 648         return ERROR_OK;
 649 }
 650
 651 #define jlink_dump_printf(context, expr ...)    \
 652         do {                                    \
 653         if (context)                            \
 654                 command_print(context, expr);   \
 655         else                                    \
 656                 LOG_INFO(expr);                 \
 657         } while(0);
 658
 659
 660 static void jlink_caps_dump(struct command_context *ctx)
 661 {
 662         int i;
 663
 664         jlink_dump_printf(ctx, "J-Link Capabilities");
 665
 666         for (i = 1; i < 31; i++)
 667                 if (jlink_caps & (1 << i))
 668                         jlink_dump_printf(ctx, "%s", jlink_cap_str[i]);
 669 }
 670
 671 static void jlink_config_usb_address_dump(struct command_context *ctx, struct jlink_config *cfg)
 672 {
 673         if (!cfg)
 674                 return;
 675
 676         jlink_dump_printf(ctx, "USB-Address: 0x%x", cfg->usb_address);
 677 }
 678
 679 static void jlink_config_kickstart_dump(struct command_context *ctx, struct jlink_config *cfg)
 680 {
 681         if (!cfg)
 682                 return;
 683
 684         jlink_dump_printf(ctx, "Kickstart power on JTAG-pin 19: 0x%x",
 685                 cfg->kickstart_power_on_jtag_pin_19);
 686 }
 687
 688 static void jlink_config_mac_address_dump(struct command_context *ctx, struct jlink_config *cfg)
 689 {
 690         if (!cfg)
 691                 return;
 692
 693         jlink_dump_printf(ctx, "MAC Address: %.02x:%.02x:%.02x:%.02x:%.02x:%.02x",
 694                 cfg->mac_address[5], cfg->mac_address[4],
 695                 cfg->mac_address[3], cfg->mac_address[2],
 696                 cfg->mac_address[1], cfg->mac_address[0]);
 697 }
 698
 699 static void jlink_config_ip_dump(struct command_context *ctx, struct jlink_config *cfg)
 700 {
 701         if (!cfg)
 702                 return;
 703
 704         jlink_dump_printf(ctx, "IP Address: %d.%d.%d.%d",
 705                 cfg->ip_address[3], cfg->ip_address[2],
 706                 cfg->ip_address[1], cfg->ip_address[0]);
 707         jlink_dump_printf(ctx, "Subnet Mask: %d.%d.%d.%d",
 708                 cfg->subnet_mask[3], cfg->subnet_mask[2],
 709                 cfg->subnet_mask[1], cfg->subnet_mask[0]);
 710 }
 711
 712 static void jlink_config_dump(struct command_context *ctx, struct jlink_config *cfg)
 713 {
 714         if (!cfg)
 715                 return;
 716
 717         jlink_dump_printf(ctx, "J-Link configuration");
 718         jlink_config_usb_address_dump(ctx, cfg);
 719         jlink_config_kickstart_dump(ctx, cfg);
 720
 721         if (jlink_hw_type == JLINK_HW_TYPE_JLINK_PRO)
 722         {
 723                 jlink_config_ip_dump(ctx, cfg);
 724                 jlink_config_mac_address_dump(ctx, cfg);
 725         }
 726 }
 727
 728 static int jlink_get_config(struct jlink_config *cfg)
 729 {
 730         int result;
 731         int size = sizeof(struct jlink_config);
 732
 733         jlink_simple_command(EMU_CMD_READ_CONFIG);
 734
 735         result = jlink_usb_read(jlink_handle, size);
 736         if (size != result)
 737         {
 738                 LOG_ERROR("jlink_usb_read failed (requested=%d, result=%d)", size, result);
 739                 return ERROR_FAIL;
 740         }
 741
 742         memcpy(cfg, usb_in_buffer, size);
 743
 744         /*
 745          * Section 4.2.4 IN-transaction
 746          * read dummy 0-byte packet
 747          */
 748         jlink_usb_read(jlink_handle, 1);
 749
 750         return ERROR_OK;
 751 }
 752
 753 static int jlink_set_config(struct jlink_config *cfg)
 754 {
 755         int result;
 756         int size = sizeof(struct jlink_config);
 757
 758         jlink_simple_command(EMU_CMD_WRITE_CONFIG);
 759
 760         memcpy(usb_out_buffer, cfg, size);
 761
 762         result = jlink_usb_write(jlink_handle, size);
 763         if (result != size)
 764         {
 765                 LOG_ERROR("jlink_usb_write failed (requested=%d, result=%d)", 256, result);
 766                 return ERROR_FAIL;
 767         }
 768
 769         return ERROR_OK;
 770 }
 771
 772 static int jlink_get_version_info(void)
 773 {
 774         int result;
 775         int len;
 776         uint32_t jlink_max_size;
 777
 778         /* query hardware version */
 779         jlink_simple_command(EMU_CMD_VERSION);
 780
 781         result = jlink_usb_read(jlink_handle, 2);
 782         if (2 != result)
 783         {
 784                 LOG_ERROR("J-Link command EMU_CMD_VERSION failed (%d)", result);
 785                 return ERROR_JTAG_DEVICE_ERROR;
 786         }
 787
 788         len = buf_get_u32(usb_in_buffer, 0, 16);
 789         if (len > JLINK_IN_BUFFER_SIZE)
 790         {
 791                 LOG_ERROR("J-Link command EMU_CMD_VERSION impossible return length 0x%0x", len);
 792                 len = JLINK_IN_BUFFER_SIZE;
 793         }
 794
 795         result = jlink_usb_read(jlink_handle, len);
 796         if (result != len)
 797         {
 798                 LOG_ERROR("J-Link command EMU_CMD_VERSION failed (%d)", result);
 799                 return ERROR_JTAG_DEVICE_ERROR;
 800         }
 801
 802         usb_in_buffer[result] = 0;
 803         LOG_INFO("%s", (char *)usb_in_buffer);
 804
 805         /* query hardware capabilities */
 806         jlink_simple_command(EMU_CMD_GET_CAPS);
 807
 808         result = jlink_usb_read(jlink_handle, 4);
 809         if (4 != result)
 810         {
 811                 LOG_ERROR("J-Link command EMU_CMD_GET_CAPS failed (%d)", result);
 812                 return ERROR_JTAG_DEVICE_ERROR;
 813         }
 814
 815         jlink_caps = buf_get_u32(usb_in_buffer, 0, 32);
 816         LOG_INFO("J-Link caps 0x%x", (unsigned)jlink_caps);
 817
 818         if (jlink_caps & (1 << EMU_CAP_GET_HW_VERSION))
 819         {
 820                 /* query hardware version */
 821                 jlink_simple_command(EMU_CMD_GET_HW_VERSION);
 822
 823                 result = jlink_usb_read(jlink_handle, 4);
 824                 if (4 != result)
 825                 {
 826                         LOG_ERROR("J-Link command EMU_CMD_GET_HW_VERSION failed (%d)", result);
 827                         return ERROR_JTAG_DEVICE_ERROR;
 828                 }
 829
 830                 uint32_t jlink_hw_version = buf_get_u32(usb_in_buffer, 0, 32);
 831                 uint32_t major_revision = (jlink_hw_version / 10000) % 100;
 832                 jlink_hw_type = (jlink_hw_version / 1000000) % 100;
 833                 if (major_revision >= 5)
 834                         jlink_hw_jtag_version = 3;
 835
 836                 LOG_INFO("J-Link hw version %i", (int)jlink_hw_version);
 837
 838                 if (jlink_hw_type >= JLINK_HW_TYPE_MAX)
 839                         LOG_INFO("J-Link hw type uknown 0x%x", jlink_hw_type);
 840                 else
 841                         LOG_INFO("J-Link hw type %s", jlink_hw_type_str[jlink_hw_type]);
 842         }
 843
 844         if (jlink_caps & (1 << EMU_CAP_GET_MAX_BLOCK_SIZE))
 845         {
 846                 /* query hardware maximum memory block */
 847                 jlink_simple_command(EMU_CMD_GET_MAX_MEM_BLOCK);
 848
 849                 result = jlink_usb_read(jlink_handle, 4);
 850                 if (4 != result)
 851                 {
 852                         LOG_ERROR("J-Link command EMU_CMD_GET_MAX_MEM_BLOCK failed (%d)", result);
 853                         return ERROR_JTAG_DEVICE_ERROR;
 854                 }
 855
 856                 jlink_max_size = buf_get_u32(usb_in_buffer, 0, 32);
 857                 LOG_INFO("J-Link max mem block %i", (int)jlink_max_size);
 858         }
 859
 860         if (jlink_caps & (1 << EMU_CAP_READ_CONFIG))
 861         {
 862                 if (jlink_get_config(&jlink_cfg) != ERROR_OK)
 863                         return ERROR_JTAG_DEVICE_ERROR;
 864
 865                 jlink_config_dump(NULL, &jlink_cfg);
 866         }
 867
 868         return ERROR_OK;
 869 }
 870
 871 COMMAND_HANDLER(jlink_pid_command)
 872 {
 873         if (CMD_ARGC != 1)
 874         {
 875                 LOG_ERROR("Need exactly one argument to jlink_pid");
 876                 return ERROR_FAIL;
 877         }
 878
 879         pids[0] = strtoul(CMD_ARGV[0], NULL, 16);
 880         pids[1] = 0;
 881         vids[1] = 0;
 882
 883         return ERROR_OK;
 884 }
 885
 886 COMMAND_HANDLER(jlink_handle_jlink_info_command)
 887 {
 888         if (jlink_get_version_info() == ERROR_OK)
 889         {
 890                 /* attempt to get status */
 891                 jlink_get_status();
 892         }
 893
 894         return ERROR_OK;
 895 }
 896
 897 COMMAND_HANDLER(jlink_handle_jlink_caps_command)
 898 {
 899         jlink_caps_dump(CMD_CTX);
 900
 901         return ERROR_OK;
 902 }
 903
 904 COMMAND_HANDLER(jlink_handle_jlink_hw_jtag_command)
 905 {
 906         switch (CMD_ARGC) {
 907         case 0:
 908                 command_print(CMD_CTX, "J-Link hw jtag  %i", jlink_hw_jtag_version);
 909                 break;
 910         case 1: {
 911                 int request_version = atoi(CMD_ARGV[0]);
 912                 switch (request_version) {
 913                 case 2: case 3:
 914                         jlink_hw_jtag_version = request_version;
 915                         break;
 916                 default:
 917                         return ERROR_COMMAND_SYNTAX_ERROR;
 918                 }
 919                 break;
 920         }
 921         default:
 922                 return ERROR_COMMAND_SYNTAX_ERROR;
 923         }
 924
 925         return ERROR_OK;
 926 }
 927
 928 COMMAND_HANDLER(jlink_handle_jlink_kickstart_command)
 929 {
 930         uint32_t kickstart;
 931
 932         if (CMD_ARGC < 1)
 933         {
 934                 jlink_config_kickstart_dump(CMD_CTX, &jlink_cfg);
 935                 return ERROR_OK;
 936         }
 937
 938         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], kickstart);
 939
 940         jlink_cfg.kickstart_power_on_jtag_pin_19 = kickstart;
 941         return ERROR_OK;
 942 }
 943
 944 COMMAND_HANDLER(jlink_handle_jlink_mac_address_command)
 945 {
 946         uint8_t addr[6];
 947         int i;
 948         char *e;
 949         const char *str;
 950
 951         if (CMD_ARGC < 1)
 952         {
 953                 jlink_config_mac_address_dump(CMD_CTX, &jlink_cfg);
 954                 return ERROR_OK;
 955         }
 956
 957         str = CMD_ARGV[0];
 958
 959         if ((strlen(str) != 17) || (str[2] != ':' || str[5] != ':' || str[8] != ':' ||
 960                 str[11] != ':' || str[14] != ':'))
 961         {
 962                 command_print(CMD_CTX, "ethaddr miss format ff:ff:ff:ff:ff:ff");
 963                 return ERROR_COMMAND_SYNTAX_ERROR;
 964         }
 965
 966         for (i = 5; i >= 0; i--)
 967         {
 968                 addr[i] = strtoul(str, &e, 16);
 969                 str = e + 1;
 970         }
 971
 972         if (!(addr[0] | addr[1] | addr[2] | addr[3] | addr[4] | addr[5]))
 973         {
 974                 command_print(CMD_CTX, "invalid it's zero mac_address");
 975                 return ERROR_COMMAND_SYNTAX_ERROR;
 976         }
 977
 978         if (!(0x01 & addr[0]))
 979         {
 980                 command_print(CMD_CTX, "invalid it's a multicat mac_address");
 981                 return ERROR_COMMAND_SYNTAX_ERROR;
 982         }
 983
 984         memcpy(jlink_cfg.mac_address, addr, sizeof(addr));
 985
 986         return ERROR_OK;
 987 }
 988
 989 static int string_to_ip(const char *s, uint8_t *ip, int *pos)
 990 {
 991         uint8_t lip[4];
 992         char *e;
 993         const char *s_save = s;
 994         int i;
 995
 996         if (!s)
 997                 return -EINVAL;
 998
 999         for (i = 0; i < 4; i++) {
1000                 lip[i] = strtoul(s, &e, 10);
1001
1002                 if (*e != '.' && i != 3)
1003                         return -EINVAL;
1004
1005                 s = e + 1;
1006         }
1007
1008         *pos = e - s_save;
1009
1010         memcpy(ip, lip, sizeof(lip));
1011         return ERROR_OK;
1012 }
1013
1014 static void cpy_ip(uint8_t *dst, uint8_t *src)
1015 {
1016         int i, j;
1017
1018         for (i = 0, j = 3; i < 4; i++, j--)
1019                 dst[i] = src[j];
1020 }
1021
1022 COMMAND_HANDLER(jlink_handle_jlink_ip_command)
1023 {
1024         uint32_t ip_address;
1025         uint32_t subnet_mask = 0;
1026         int i, len;
1027         int ret;
1028         uint8_t subnet_bits = 24;
1029
1030         if (CMD_ARGC < 1)
1031         {
1032                 jlink_config_ip_dump(CMD_CTX, &jlink_cfg);
1033                 return ERROR_OK;
1034         }
1035
1036         ret = string_to_ip(CMD_ARGV[0], (uint8_t*)&ip_address, &i);
1037         if (ret != ERROR_OK)
1038                 return ret;
1039
1040         len = strlen(CMD_ARGV[0]);
1041
1042         /* check for this format A.B.C.D/E */
1043
1044         if (i < len)
1045         {
1046                 if (CMD_ARGV[0][i] != '/')
1047                         return ERROR_COMMAND_SYNTAX_ERROR;
1048
1049                 COMMAND_PARSE_NUMBER(u8, CMD_ARGV[0] + i + 1, subnet_bits);
1050         }
1051         else
1052         {
1053                 if (CMD_ARGC > 1)
1054                 {
1055                         ret = string_to_ip(CMD_ARGV[1], (uint8_t*)&subnet_mask, &i);
1056                         if (ret != ERROR_OK)
1057                                 return ret;
1058                 }
1059         }
1060
1061         if (!subnet_mask)
1062                 subnet_mask = (uint32_t)(subnet_bits < 32 ?
1063                                 ((1ULL << subnet_bits) -1) : 0xffffffff);
1064
1065         cpy_ip(jlink_cfg.ip_address, (uint8_t*)&ip_address);
1066         cpy_ip(jlink_cfg.subnet_mask, (uint8_t*)&subnet_mask);
1067
1068         return ERROR_OK;
1069 }
1070
1071 COMMAND_HANDLER(jlink_handle_jlink_reset_command)
1072 {
1073         memset(&jlink_cfg, 0xff, sizeof(jlink_cfg));
1074         return ERROR_OK;
1075 }
1076
1077 COMMAND_HANDLER(jlink_handle_jlink_save_command)
1078 {
1079         if (!(jlink_caps & (1 << EMU_CAP_WRITE_CONFIG)))
1080         {
1081                 command_print(CMD_CTX, "J-Link write emulator configuration not supported");
1082                 return ERROR_OK;
1083         }
1084
1085         command_print(CMD_CTX, "The J-Link need to be unpluged and repluged ta have the config effective");
1086         return jlink_set_config(&jlink_cfg);
1087 }
1088
1089 COMMAND_HANDLER(jlink_handle_jlink_usb_address_command)
1090 {
1091         uint32_t address;
1092
1093         if (CMD_ARGC < 1)
1094         {
1095                 jlink_config_usb_address_dump(CMD_CTX, &jlink_cfg);
1096                 return ERROR_OK;
1097         }
1098
1099         COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
1100
1101         if (address > 0x3 && address != 0xff)
1102         {
1103                 command_print(CMD_CTX, "USB Address must be between 0x00 and 0x03 or 0xff");
1104                 return ERROR_COMMAND_SYNTAX_ERROR;
1105         }
1106
1107         jlink_cfg.usb_address = address;
1108         return ERROR_OK;
1109 }
1110
1111 COMMAND_HANDLER(jlink_handle_jlink_config_command)
1112 {
1113         struct jlink_config cfg;
1114         int ret = ERROR_OK;
1115
1116         if (CMD_ARGC == 0)
1117         {
1118                 if (!(jlink_caps & (1 << EMU_CAP_READ_CONFIG)))
1119                 {
1120                         command_print(CMD_CTX, "J-Link read emulator configuration not supported");
1121                         goto exit;
1122                 }
1123
1124                 ret = jlink_get_config(&cfg);
1125
1126                 if ( ret != ERROR_OK)
1127                         command_print(CMD_CTX, "J-Link read emulator configuration failled");
1128                 else
1129                         jlink_config_dump(CMD_CTX, &jlink_cfg);
1130         }
1131
1132 exit:
1133         return ret;
1134 }
1135
1136 static const struct command_registration jlink_config_subcommand_handlers[] = {
1137         {
1138                 .name = "kickstart",
1139                 .handler = &jlink_handle_jlink_kickstart_command,
1140                 .mode = COMMAND_EXEC,
1141                 .help = "set Kickstart power on JTAG-pin 19.",
1142                 .usage = "[val]",
1143         },
1144         {
1145                 .name = "mac_address",
1146                 .handler = &jlink_handle_jlink_mac_address_command,
1147                 .mode = COMMAND_EXEC,
1148                 .help = "set the MAC Address",
1149                 .usage = "[ff:ff:ff:ff:ff:ff]",
1150         },
1151         {
1152                 .name = "ip",
1153                 .handler = &jlink_handle_jlink_ip_command,
1154                 .mode = COMMAND_EXEC,
1155                 .help = "set the ip address of the J-Link Pro, "
1156                         "where A.B.C.D is the ip, "
1157                         "E the bit of the subnet mask, "
1158                         "F.G.H.I the subnet mask",
1159                 .usage = "[A.B.C.D[/E] [F.G.H.I]]",
1160         },
1161         {
1162                 .name = "reset",
1163                 .handler = &jlink_handle_jlink_reset_command,
1164                 .mode = COMMAND_EXEC,
1165                 .help = "reset the current config",
1166         },
1167         {
1168                 .name = "save",
1169                 .handler = &jlink_handle_jlink_save_command,
1170                 .mode = COMMAND_EXEC,
1171                 .help = "save the current config",
1172         },
1173         {
1174                 .name = "usb_address",
1175                 .handler = &jlink_handle_jlink_usb_address_command,
1176                 .mode = COMMAND_EXEC,
1177                 .help = "set the USB-Address, "
1178                         "This will change the product id",
1179                 .usage = "[0x00 to 0x03 or 0xff]",
1180         },
1181         COMMAND_REGISTRATION_DONE
1182 };
1183
1184 static const struct command_registration jlink_subcommand_handlers[] = {
1185         {
1186                 .name = "caps",
1187                 .handler = &jlink_handle_jlink_caps_command,
1188                 .mode = COMMAND_EXEC,
1189                 .help = "show jlink capabilities",
1190         },
1191         {
1192                 .name = "info",
1193                 .handler = &jlink_handle_jlink_info_command,
1194                 .mode = COMMAND_EXEC,
1195                 .help = "show jlink info",
1196         },
1197         {
1198                 .name = "hw_jtag",
1199                 .handler = &jlink_handle_jlink_hw_jtag_command,
1200                 .mode = COMMAND_EXEC,
1201                 .help = "access J-Link HW JTAG command version",
1202                 .usage = "[2|3]",
1203         },
1204         {
1205                 .name = "config",
1206                 .handler = &jlink_handle_jlink_config_command,
1207                 .mode = COMMAND_EXEC,
1208                 .help = "access J-Link configuration, "
1209                         "if no argument this will dump the config",
1210                 .chain = jlink_config_subcommand_handlers,
1211         },
1212         {
1213                 .name = "pid",
1214                 .handler = &jlink_pid_command,
1215                 .mode = COMMAND_CONFIG,
1216                 .help = "set the pid of the interface we want to use",
1217         },
1218         COMMAND_REGISTRATION_DONE
1219 };
1220
1221 static const struct command_registration jlink_command_handlers[] = {
1222         {
1223                 .name = "jlink",
1224                 .mode = COMMAND_ANY,
1225                 .help = "perform jlink management",
1226                 .chain = jlink_subcommand_handlers,
1227         },
1228         COMMAND_REGISTRATION_DONE
1229 };
1230
1231 struct jtag_interface jlink_interface = {
1232         .name = "jlink",
1233         .commands = jlink_command_handlers,
1234
1235         .execute_queue = jlink_execute_queue,
1236         .speed = jlink_speed,
1237         .speed_div = jlink_speed_div,
1238         .khz = jlink_khz,
1239         .init = jlink_init,
1240         .quit = jlink_quit,
1241 };
1242
1243 /***************************************************************************/
1244 /* J-Link tap functions */
1245
1246
1247 static unsigned tap_length = 0;
1248 static uint8_t tms_buffer[JLINK_TAP_BUFFER_SIZE];
1249 static uint8_t tdi_buffer[JLINK_TAP_BUFFER_SIZE];
1250 static uint8_t tdo_buffer[JLINK_TAP_BUFFER_SIZE];
1251
1252 struct pending_scan_result {
1253         int first;      /* First bit position in tdo_buffer to read */
1254         int length; /* Number of bits to read */
1255         struct scan_command *command; /* Corresponding scan command */
1256         uint8_t *buffer;
1257 };
1258
1259 #define MAX_PENDING_SCAN_RESULTS 256
1260
1261 static int pending_scan_results_length;
1262 static struct pending_scan_result pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
1263
1264 static void jlink_tap_init(void)
1265 {
1266         tap_length = 0;
1267         pending_scan_results_length = 0;
1268 }
1269
1270 static void jlink_tap_ensure_space(int scans, int bits)
1271 {
1272         int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
1273         int available_bits = JLINK_TAP_BUFFER_SIZE * 8 - tap_length - 32;
1274
1275         if (scans > available_scans || bits > available_bits)
1276         {
1277                 jlink_tap_execute();
1278         }
1279 }
1280
1281 static void jlink_tap_append_step(int tms, int tdi)
1282 {
1283         int index_var = tap_length / 8;
1284
1285         if (index_var >= JLINK_TAP_BUFFER_SIZE)
1286         {
1287                 LOG_ERROR("jlink_tap_append_step: overflow");
1288                 *(uint32_t *)0xFFFFFFFF = 0;
1289                 exit(-1);
1290         }
1291
1292         int bit_index = tap_length % 8;
1293         uint8_t bit = 1 << bit_index;
1294
1295         // we do not pad TMS, so be sure to initialize all bits
1296         if (0 == bit_index)
1297         {
1298                 tms_buffer[index_var] = tdi_buffer[index_var] = 0;
1299         }
1300
1301         if (tms)
1302                 tms_buffer[index_var] |= bit;
1303         else
1304                 tms_buffer[index_var] &= ~bit;
1305
1306         if (tdi)
1307                 tdi_buffer[index_var] |= bit;
1308         else
1309                 tdi_buffer[index_var] &= ~bit;
1310
1311         tap_length++;
1312 }
1313
1314 static void jlink_tap_append_scan(int length, uint8_t *buffer,
1315                 struct scan_command *command)
1316 {
1317         struct pending_scan_result *pending_scan_result =
1318                 &pending_scan_results_buffer[pending_scan_results_length];
1319         int i;
1320
1321         pending_scan_result->first = tap_length;
1322         pending_scan_result->length = length;
1323         pending_scan_result->command = command;
1324         pending_scan_result->buffer = buffer;
1325
1326         for (i = 0; i < length; i++)
1327         {
1328                 int tms = (i < (length - 1)) ? 0 : 1;
1329                 int tdi = (buffer[i / 8] & (1 << (i % 8))) != 0;
1330                 jlink_tap_append_step(tms, tdi);
1331         }
1332         pending_scan_results_length++;
1333 }
1334
1335 /* Pad and send a tap sequence to the device, and receive the answer.
1336  * For the purpose of padding we assume that we are in idle or pause state. */
1337 static int jlink_tap_execute(void)
1338 {
1339         int byte_length;
1340         int i;
1341         int result;
1342
1343         if (!tap_length)
1344                 return ERROR_OK;
1345
1346         /* JLink returns an extra NULL in packet when size of incoming
1347          * message is a multiple of 64, creates problems with USB comms.
1348          * WARNING: This will interfere with tap state counting. */
1349         while ((DIV_ROUND_UP(tap_length, 8) % 64) == 0)
1350         {
1351                 jlink_tap_append_step((tap_get_state() == TAP_RESET) ? 1 : 0, 0);
1352         }
1353
1354         // number of full bytes (plus one if some would be left over)
1355         byte_length = DIV_ROUND_UP(tap_length, 8);
1356
1357         bool use_jtag3 = jlink_hw_jtag_version >= 3;
1358         usb_out_buffer[0] = use_jtag3 ? EMU_CMD_HW_JTAG3 : EMU_CMD_HW_JTAG2;
1359         usb_out_buffer[1] = 0;
1360         usb_out_buffer[2] = (tap_length >> 0) & 0xff;
1361         usb_out_buffer[3] = (tap_length >> 8) & 0xff;
1362         memcpy(usb_out_buffer + 4, tms_buffer, byte_length);
1363         memcpy(usb_out_buffer + 4 + byte_length, tdi_buffer, byte_length);
1364
1365         jlink_last_state = jtag_debug_state_machine(tms_buffer, tdi_buffer,
1366                         tap_length, jlink_last_state);
1367
1368         result = jlink_usb_message(jlink_handle, 4 + 2 * byte_length, byte_length);
1369         if (result != byte_length)
1370         {
1371                 LOG_ERROR("jlink_tap_execute, wrong result %d (expected %d)",
1372                                 result, byte_length);
1373                 jlink_tap_init();
1374                 return ERROR_JTAG_QUEUE_FAILED;
1375         }
1376
1377         memcpy(tdo_buffer, usb_in_buffer, byte_length);
1378
1379         for (i = 0; i < pending_scan_results_length; i++)
1380         {
1381                 struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[i];
1382                 uint8_t *buffer = pending_scan_result->buffer;
1383                 int length = pending_scan_result->length;
1384                 int first = pending_scan_result->first;
1385                 struct scan_command *command = pending_scan_result->command;
1386
1387                 /* Copy to buffer */
1388                 buf_set_buf(tdo_buffer, first, buffer, 0, length);
1389
1390                 DEBUG_JTAG_IO("pending scan result, length = %d", length);
1391
1392                 jlink_debug_buffer(buffer, DIV_ROUND_UP(length, 8));
1393
1394                 if (jtag_read_buffer(buffer, command) != ERROR_OK)
1395                 {
1396                         jlink_tap_init();
1397                         return ERROR_JTAG_QUEUE_FAILED;
1398                 }
1399
1400                 if (pending_scan_result->buffer != NULL)
1401                 {
1402                         free(pending_scan_result->buffer);
1403                 }
1404         }
1405
1406         jlink_tap_init();
1407         return ERROR_OK;
1408 }
1409
1410 /*****************************************************************************/
1411 /* JLink USB low-level functions */
1412
1413 static struct jlink* jlink_usb_open()
1414 {
1415         usb_init();
1416
1417         struct usb_dev_handle *dev;
1418         if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
1419                 return NULL;
1420
1421         /* BE ***VERY CAREFUL*** ABOUT MAKING CHANGES IN THIS
1422          * AREA!!!!!!!!!!!  The behavior of libusb is not completely
1423          * consistent across Windows, Linux, and Mac OS X platforms.
1424          * The actions taken in the following compiler conditionals may
1425          * not agree with published documentation for libusb, but were
1426          * found to be necessary through trials and tribulations.  Even
1427          * little tweaks can break one or more platforms, so if you do
1428          * make changes test them carefully on all platforms before
1429          * committing them!
1430          */
1431
1432 #if IS_WIN32 == 0
1433
1434         usb_reset(dev);
1435
1436 #if IS_DARWIN == 0
1437
1438         int timeout = 5;
1439         /* reopen jlink after usb_reset
1440          * on win32 this may take a second or two to re-enumerate */
1441         int retval;
1442         while ((retval = jtag_usb_open(vids, pids, &dev)) != ERROR_OK)
1443         {
1444                 usleep(1000);
1445                 timeout--;
1446                 if (!timeout) {
1447                         break;
1448                 }
1449         }
1450         if (ERROR_OK != retval)
1451                 return NULL;
1452 #endif
1453
1454 #endif
1455
1456         /* usb_set_configuration required under win32 */
1457         struct usb_device *udev = usb_device(dev);
1458         usb_set_configuration(dev, udev->config[0].bConfigurationValue);
1459         usb_claim_interface(dev, 0);
1460
1461 #if 0
1462         /*
1463          * This makes problems under Mac OS X. And is not needed
1464          * under Windows. Hopefully this will not break a linux build
1465          */
1466         usb_set_altinterface(result->usb_handle, 0);
1467 #endif
1468         struct usb_interface *iface = udev->config->interface;
1469         struct usb_interface_descriptor *desc = iface->altsetting;
1470         for (int i = 0; i < desc->bNumEndpoints; i++)
1471         {
1472                 uint8_t epnum = desc->endpoint[i].bEndpointAddress;
1473                 bool is_input = epnum & 0x80;
1474                 LOG_DEBUG("usb ep %s %02x", is_input ? "in" : "out", epnum);
1475                 if (is_input)
1476                         jlink_read_ep = epnum;
1477                 else
1478                         jlink_write_ep = epnum;
1479         }
1480
1481         struct jlink *result = malloc(sizeof(struct jlink));
1482         result->usb_handle = dev;
1483         return result;
1484 }
1485
1486 static void jlink_usb_close(struct jlink *jlink)
1487 {
1488         usb_close(jlink->usb_handle);
1489         free(jlink);
1490 }
1491
1492 /* Send a message and receive the reply. */
1493 static int jlink_usb_message(struct jlink *jlink, int out_length, int in_length)
1494 {
1495         int result;
1496
1497         result = jlink_usb_write(jlink, out_length);
1498         if (result != out_length)
1499         {
1500                 LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)",
1501                                 out_length, result);
1502                 return ERROR_JTAG_DEVICE_ERROR;
1503         }
1504
1505         result = jlink_usb_read(jlink, in_length);
1506         if ((result != in_length) && (result != (in_length + 1)))
1507         {
1508                 LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)",
1509                                 in_length, result);
1510                 return ERROR_JTAG_DEVICE_ERROR;
1511         }
1512
1513         if (jlink_hw_jtag_version < 3)
1514                 return result;
1515
1516         int result2 = ERROR_OK;
1517         if (result == in_length)
1518         {
1519                 /* Must read the result from the EMU too */
1520                 result2 = jlink_usb_read_emu_result(jlink);
1521                 if (1 != result2)
1522                 {
1523                         LOG_ERROR("jlink_usb_read_emu_result retried requested = 1, "
1524                                         "result=%d, in_length=%i", result2, in_length);
1525                         /* Try again once, should only happen if (in_length%64 == 0) */
1526                         result2 = jlink_usb_read_emu_result(jlink);
1527                         if (1 != result2)
1528                         {
1529                                 LOG_ERROR("jlink_usb_read_emu_result failed "
1530                                         "(requested = 1, result=%d)", result2);
1531                                 return ERROR_JTAG_DEVICE_ERROR;
1532                         }
1533                 }
1534
1535                 /* Check the result itself */
1536                 result2 = usb_emu_result_buffer[0];
1537         }
1538         else
1539         {
1540                 /* Save the result, then remove it from return value */
1541                 result2 = usb_in_buffer[result--];
1542         }
1543
1544         if (result2)
1545         {
1546                 LOG_ERROR("jlink_usb_message failed with result=%d)", result2);
1547                 return ERROR_JTAG_DEVICE_ERROR;
1548         }
1549
1550         return result;
1551 }
1552
1553 /* calls the given usb_bulk_* function, allowing for the data to
1554  * trickle in with some timeouts  */
1555 static int usb_bulk_with_retries(
1556                 int (*f)(usb_dev_handle *, int, char *, int, int),
1557                 usb_dev_handle *dev, int ep,
1558                 char *bytes, int size, int timeout)
1559 {
1560         int tries = 3, count = 0;
1561
1562         while (tries && (count < size))
1563         {
1564                 int result = f(dev, ep, bytes + count, size - count, timeout);
1565                 if (result > 0)
1566                         count += result;
1567                 else if ((-ETIMEDOUT != result) || !--tries)
1568                         return result;
1569         }
1570         return count;
1571 }
1572
1573 static int wrap_usb_bulk_write(usb_dev_handle *dev, int ep,
1574                                char *buff, int size, int timeout)
1575 {
1576         /* usb_bulk_write() takes const char *buff */
1577         return usb_bulk_write(dev, ep, buff, size, timeout);
1578 }
1579
1580 static inline int usb_bulk_write_ex(usb_dev_handle *dev, int ep,
1581                 char *bytes, int size, int timeout)
1582 {
1583         return usb_bulk_with_retries(&wrap_usb_bulk_write,
1584                         dev, ep, bytes, size, timeout);
1585 }
1586
1587 static inline int usb_bulk_read_ex(usb_dev_handle *dev, int ep,
1588                 char *bytes, int size, int timeout)
1589 {
1590         return usb_bulk_with_retries(&usb_bulk_read,
1591                         dev, ep, bytes, size, timeout);
1592 }
1593
1594 /* Write data from out_buffer to USB. */
1595 static int jlink_usb_write(struct jlink *jlink, int out_length)
1596 {
1597         int result;
1598
1599         if (out_length > JLINK_OUT_BUFFER_SIZE)
1600         {
1601                 LOG_ERROR("jlink_write illegal out_length=%d (max=%d)",
1602                                 out_length, JLINK_OUT_BUFFER_SIZE);
1603                 return -1;
1604         }
1605
1606         result = usb_bulk_write_ex(jlink->usb_handle, jlink_write_ep,
1607                 (char *)usb_out_buffer, out_length, JLINK_USB_TIMEOUT);
1608
1609         DEBUG_JTAG_IO("jlink_usb_write, out_length = %d, result = %d",
1610                         out_length, result);
1611
1612         jlink_debug_buffer(usb_out_buffer, out_length);
1613         return result;
1614 }
1615
1616 /* Read data from USB into in_buffer. */
1617 static int jlink_usb_read(struct jlink *jlink, int expected_size)
1618 {
1619         int result = usb_bulk_read_ex(jlink->usb_handle, jlink_read_ep,
1620                 (char *)usb_in_buffer, expected_size, JLINK_USB_TIMEOUT);
1621
1622         DEBUG_JTAG_IO("jlink_usb_read, result = %d", result);
1623
1624         jlink_debug_buffer(usb_in_buffer, result);
1625         return result;
1626 }
1627
1628 /* Read the result from the previous EMU cmd into result_buffer. */
1629 static int jlink_usb_read_emu_result(struct jlink *jlink)
1630 {
1631         int result = usb_bulk_read_ex(jlink->usb_handle, jlink_read_ep,
1632                 (char *)usb_emu_result_buffer, 1 /* JLINK_EMU_RESULT_BUFFER_SIZE */,
1633                 JLINK_USB_TIMEOUT);
1634
1635         DEBUG_JTAG_IO("jlink_usb_read_result, result = %d", result);
1636
1637         jlink_debug_buffer(usb_emu_result_buffer, result);
1638         return result;
1639 }
1640
1641 #ifdef _DEBUG_USB_COMMS_
1642 #define BYTES_PER_LINE  16
1643
1644 static void jlink_debug_buffer(uint8_t *buffer, int length)
1645 {
1646         char line[81];
1647         char s[4];
1648         int i;
1649         int j;
1650
1651         for (i = 0; i < length; i += BYTES_PER_LINE)
1652         {
1653                 snprintf(line, 5, "%04x", i);
1654                 for (j = i; j < i + BYTES_PER_LINE && j < length; j++)
1655                 {
1656                         snprintf(s, 4, " %02x", buffer[j]);
1657                         strcat(line, s);
1658                 }
1659                 LOG_DEBUG("%s", line);
1660         }
1661 }
1662 #endif