src/jtag/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  *   This program is free software; you can redistribute it and/or modify  *
   9  *   it under the terms of the GNU General Public License as published by  *
  10  *   the Free Software Foundation; either version 2 of the License, or     *
  11  *   (at your option) any later version.                                   *
  12  *                                                                         *
  13  *   This program is distributed in the hope that it will be useful,       *
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  16  *   GNU General Public License for more details.                          *
  17  *                                                                         *
  18  *   You should have received a copy of the GNU General Public License     *
  19  *   along with this program; if not, write to the                         *
  20  *   Free Software Foundation, Inc.,                                       *
  21  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  22  ***************************************************************************/
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include "config.h"
  26 #endif
  27
  28 #include "interface.h"
  29 #include "commands.h"
  30
  31 #include <usb.h>
  32
  33
  34 #define VID 0x1366
  35 #define PID 0x0101
  36
  37 #define JLINK_WRITE_ENDPOINT    0x02
  38 #define JLINK_READ_ENDPOINT             0x81
  39
  40 static unsigned int jlink_write_ep = JLINK_WRITE_ENDPOINT;
  41 static unsigned int jlink_read_ep = JLINK_READ_ENDPOINT;
  42 static unsigned int jlink_hw_jtag_version = 2;
  43
  44 #define JLINK_USB_TIMEOUT               1000
  45
  46 // See Section 1.3.2 of the Segger JLink USB protocol manual
  47 /* 2048 is the max value we can use here */
  48 //#define JLINK_TAP_BUFFER_SIZE 2048
  49 #define JLINK_TAP_BUFFER_SIZE 256
  50 //#define JLINK_TAP_BUFFER_SIZE 384
  51
  52 #define JLINK_IN_BUFFER_SIZE                    2048
  53 #define JLINK_OUT_BUFFER_SIZE                   2*2048+4
  54 #define JLINK_EMU_RESULT_BUFFER_SIZE    64
  55
  56 /* Global USB buffers */
  57 static uint8_t usb_in_buffer[JLINK_IN_BUFFER_SIZE];
  58 static uint8_t usb_out_buffer[JLINK_OUT_BUFFER_SIZE];
  59 static uint8_t usb_emu_result_buffer[JLINK_EMU_RESULT_BUFFER_SIZE];
  60
  61 /* Constants for JLink command */
  62 #define EMU_CMD_VERSION         0x01
  63 #define EMU_CMD_SET_SPEED               0x05
  64 #define EMU_CMD_GET_STATE               0x07
  65 #define EMU_CMD_HW_CLOCK                        0xc8
  66 #define EMU_CMD_HW_TMS0                 0xc9
  67 #define EMU_CMD_HW_TMS1                 0xca
  68 #define EMU_CMD_HW_JTAG2                0xce
  69 #define EMU_CMD_HW_JTAG3                0xcf
  70 #define EMU_CMD_GET_MAX_MEM_BLOCK       0xd4
  71 #define EMU_CMD_HW_RESET0               0xdc
  72 #define EMU_CMD_HW_RESET1               0xdd
  73 #define EMU_CMD_HW_TRST0                0xde
  74 #define EMU_CMD_HW_TRST1                0xdf
  75 #define EMU_CMD_GET_CAPS                0xe8
  76 #define EMU_CMD_GET_HW_VERSION  0xf0
  77
  78 /* bits return from EMU_CMD_GET_CAPS */
  79 #define EMU_CAP_GET_HW_VERSION          1
  80 #define EMU_CAP_GET_MAX_BLOCK_SIZE      11
  81
  82 /* max speed 12MHz v5.0 jlink */
  83 #define JLINK_MAX_SPEED 12000
  84
  85 /* External interface functions */
  86 static int jlink_execute_queue(void);
  87 static int jlink_speed(int speed);
  88 static int jlink_speed_div(int speed, int* khz);
  89 static int jlink_khz(int khz, int *jtag_speed);
  90 static int jlink_register_commands(struct command_context_s *cmd_ctx);
  91 static int jlink_init(void);
  92 static int jlink_quit(void);
  93
  94 /* CLI command handler functions */
  95 static int jlink_handle_jlink_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
  96 static int jlink_handle_jlink_hw_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
  97
  98 /* Queue command functions */
  99 static void jlink_end_state(tap_state_t state);
 100 static void jlink_state_move(void);
 101 static void jlink_path_move(int num_states, tap_state_t *path);
 102 static void jlink_runtest(int num_cycles);
 103 static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, scan_command_t *command);
 104 static void jlink_reset(int trst, int srst);
 105 static void jlink_simple_command(uint8_t command);
 106 static int jlink_get_status(void);
 107
 108 /* J-Link tap buffer functions */
 109 static void jlink_tap_init(void);
 110 static int jlink_tap_execute(void);
 111 static void jlink_tap_ensure_space(int scans, int bits);
 112 static void jlink_tap_append_step(int tms, int tdi);
 113 static void jlink_tap_append_scan(int length, uint8_t *buffer, scan_command_t *command);
 114
 115 /* Jlink lowlevel functions */
 116 typedef struct jlink_jtag
 117 {
 118         struct usb_dev_handle* usb_handle;
 119 } jlink_jtag_t;
 120
 121 static jlink_jtag_t *jlink_usb_open(void);
 122 static void jlink_usb_close(jlink_jtag_t *jlink_jtag);
 123 static int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_length);
 124 static int jlink_usb_write(jlink_jtag_t *jlink_jtag, int out_length);
 125 static int jlink_usb_read(jlink_jtag_t *jlink_jtag, int expected_size);
 126 static int jlink_usb_read_emu_result(jlink_jtag_t *jlink_jtag);
 127
 128 /* helper functions */
 129 static int jlink_get_version_info(void);
 130
 131 #ifdef _DEBUG_USB_COMMS_
 132 static void jlink_debug_buffer(uint8_t *buffer, int length);
 133 #endif
 134
 135 static enum tap_state jlink_last_state = TAP_RESET;
 136
 137 static jlink_jtag_t* jlink_jtag_handle;
 138
 139 /***************************************************************************/
 140 /* External interface implementation */
 141
 142 jtag_interface_t jlink_interface =
 143 {
 144         .name = "jlink",
 145         .execute_queue = jlink_execute_queue,
 146         .speed = jlink_speed,
 147         .speed_div = jlink_speed_div,
 148         .khz = jlink_khz,
 149         .register_commands = jlink_register_commands,
 150         .init = jlink_init,
 151         .quit = jlink_quit
 152 };
 153
 154 static void jlink_execute_runtest(jtag_command_t *cmd)
 155 {
 156         DEBUG_JTAG_IO("runtest %i cycles, end in %i",
 157                         cmd->cmd.runtest->num_cycles,
 158                         cmd->cmd.runtest->end_state);
 159
 160         jlink_end_state(cmd->cmd.runtest->end_state);
 161
 162         jlink_runtest(cmd->cmd.runtest->num_cycles);
 163 }
 164
 165 static void jlink_execute_statemove(jtag_command_t *cmd)
 166 {
 167         DEBUG_JTAG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
 168
 169         jlink_end_state(cmd->cmd.statemove->end_state);
 170         jlink_state_move();
 171 }
 172
 173 static void jlink_execute_pathmove(jtag_command_t *cmd)
 174 {
 175         DEBUG_JTAG_IO("pathmove: %i states, end in %i",
 176                 cmd->cmd.pathmove->num_states,
 177                 cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
 178
 179         jlink_path_move(cmd->cmd.pathmove->num_states,
 180                         cmd->cmd.pathmove->path);
 181 }
 182
 183 static void jlink_execute_scan(jtag_command_t *cmd)
 184 {
 185         int scan_size;
 186         enum scan_type type;
 187         uint8_t *buffer;
 188
 189         DEBUG_JTAG_IO("scan end in %s", tap_state_name(cmd->cmd.scan->end_state));
 190
 191         jlink_end_state(cmd->cmd.scan->end_state);
 192
 193         scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
 194         DEBUG_JTAG_IO("scan input, length = %d", scan_size);
 195
 196 #ifdef _DEBUG_USB_COMMS_
 197         jlink_debug_buffer(buffer, (scan_size + 7) / 8);
 198 #endif
 199         type = jtag_scan_type(cmd->cmd.scan);
 200         jlink_scan(cmd->cmd.scan->ir_scan,
 201                         type, buffer, scan_size, cmd->cmd.scan);
 202 }
 203
 204 static void jlink_execute_reset(jtag_command_t *cmd)
 205 {
 206         DEBUG_JTAG_IO("reset trst: %i srst %i",
 207                         cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 208
 209         jlink_tap_execute();
 210         jlink_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 211         jlink_tap_execute();
 212 }
 213
 214 static void jlink_execute_sleep(jtag_command_t *cmd)
 215 {
 216         DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us);
 217         jlink_tap_execute();
 218         jtag_sleep(cmd->cmd.sleep->us);
 219 }
 220
 221 static void jlink_execute_command(jtag_command_t *cmd)
 222 {
 223         switch (cmd->type)
 224         {
 225         case JTAG_RUNTEST:   jlink_execute_runtest(cmd); break;
 226         case JTAG_STATEMOVE: jlink_execute_statemove(cmd); break;
 227         case JTAG_PATHMOVE:  jlink_execute_pathmove(cmd); break;
 228         case JTAG_SCAN:      jlink_execute_scan(cmd); break;
 229         case JTAG_RESET:     jlink_execute_reset(cmd); break;
 230         case JTAG_SLEEP:     jlink_execute_sleep(cmd); break;
 231         default:
 232                 LOG_ERROR("BUG: unknown JTAG command type encountered");
 233                 exit(-1);
 234         }
 235 }
 236
 237 static int jlink_execute_queue(void)
 238 {
 239         jtag_command_t *cmd = jtag_command_queue;
 240
 241         while (cmd != NULL)
 242         {
 243                 jlink_execute_command(cmd);
 244                 cmd = cmd->next;
 245         }
 246
 247         return jlink_tap_execute();
 248 }
 249
 250 /* Sets speed in kHz. */
 251 static int jlink_speed(int speed)
 252 {
 253         int result;
 254
 255         if (speed > JLINK_MAX_SPEED)
 256         {
 257                 LOG_INFO("Ignoring speed request: %dkHz exceeds %dkHz maximum",
 258                                 speed, JLINK_MAX_SPEED);
 259                 return ERROR_OK;
 260         }
 261
 262         /* check for RTCK setting */
 263         if (speed == 0)
 264                 speed = -1;
 265
 266         usb_out_buffer[0] = EMU_CMD_SET_SPEED;
 267         usb_out_buffer[1] = (speed >> 0) & 0xff;
 268         usb_out_buffer[2] = (speed >> 8) & 0xff;
 269
 270         result = jlink_usb_write(jlink_jtag_handle, 3);
 271         if (result != 3)
 272         {
 273                 LOG_ERROR("J-Link setting speed failed (%d)", result);
 274                 return ERROR_JTAG_DEVICE_ERROR;
 275         }
 276
 277         return ERROR_OK;
 278 }
 279
 280 static int jlink_speed_div(int speed, int* khz)
 281 {
 282         *khz = speed;
 283
 284         return ERROR_OK;
 285 }
 286
 287 static int jlink_khz(int khz, int *jtag_speed)
 288 {
 289         *jtag_speed = khz;
 290
 291         return ERROR_OK;
 292 }
 293
 294 static int jlink_register_commands(struct command_context_s *cmd_ctx)
 295 {
 296
 297         register_command(cmd_ctx, NULL, "jlink_info",
 298                 &jlink_handle_jlink_info_command, COMMAND_EXEC,
 299                 "query jlink info");
 300         register_command(cmd_ctx, NULL, "jlink_hw_jtag",
 301                 &jlink_handle_jlink_hw_jtag_command, COMMAND_EXEC,
 302                 "set/get jlink hw jtag command version [2|3]");
 303         return ERROR_OK;
 304 }
 305
 306 static int jlink_init(void)
 307 {
 308         int check_cnt;
 309         int i;
 310
 311         jlink_jtag_handle = jlink_usb_open();
 312
 313         if (jlink_jtag_handle == 0)
 314         {
 315                 LOG_ERROR("Cannot find jlink Interface! Please check connection and permissions.");
 316                 return ERROR_JTAG_INIT_FAILED;
 317         }
 318
 319         jlink_hw_jtag_version = 2;
 320         check_cnt = 0;
 321         while (check_cnt < 3)
 322         {
 323                 if (jlink_get_version_info() == ERROR_OK)
 324                 {
 325                         /* attempt to get status */
 326                         jlink_get_status();
 327                         break;
 328                 }
 329
 330                 check_cnt++;
 331         }
 332
 333         if (check_cnt == 3)
 334         {
 335                 LOG_INFO("J-Link initial read failed, don't worry");
 336         }
 337
 338         LOG_INFO("J-Link JTAG Interface ready");
 339
 340         jlink_reset(0, 0);
 341         jtag_sleep(3000);
 342         jlink_tap_init();
 343         jlink_speed(jtag_get_speed());
 344
 345         /* v5/6 jlink seems to have an issue if the first tap move
 346          * is not divisible by 8, so we send a TLR on first power up */
 347         for (i = 0; i < 8; i++) {
 348                 jlink_tap_append_step(1, 0);
 349         }
 350         jlink_tap_execute();
 351
 352         return ERROR_OK;
 353 }
 354
 355 static int jlink_quit(void)
 356 {
 357         jlink_usb_close(jlink_jtag_handle);
 358         return ERROR_OK;
 359 }
 360
 361 /***************************************************************************/
 362 /* Queue command implementations */
 363
 364 static void jlink_end_state(tap_state_t state)
 365 {
 366         if (tap_is_state_stable(state))
 367         {
 368                 tap_set_end_state(state);
 369         }
 370         else
 371         {
 372                 LOG_ERROR("BUG: %i is not a valid end state", state);
 373                 exit(-1);
 374         }
 375 }
 376
 377 /* Goes to the end state. */
 378 static void jlink_state_move(void)
 379 {
 380         int i;
 381         int tms = 0;
 382         uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
 383         uint8_t tms_scan_bits = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
 384
 385         for (i = 0; i < tms_scan_bits; i++)
 386         {
 387                 tms = (tms_scan >> i) & 1;
 388                 jlink_tap_append_step(tms, 0);
 389         }
 390
 391         tap_set_state(tap_get_end_state());
 392 }
 393
 394 static void jlink_path_move(int num_states, tap_state_t *path)
 395 {
 396         int i;
 397
 398         for (i = 0; i < num_states; i++)
 399         {
 400                 if (path[i] == tap_state_transition(tap_get_state(), false))
 401                 {
 402                         jlink_tap_append_step(0, 0);
 403                 }
 404                 else if (path[i] == tap_state_transition(tap_get_state(), true))
 405                 {
 406                         jlink_tap_append_step(1, 0);
 407                 }
 408                 else
 409                 {
 410                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(path[i]));
 411                         exit(-1);
 412                 }
 413
 414                 tap_set_state(path[i]);
 415         }
 416
 417         tap_set_end_state(tap_get_state());
 418 }
 419
 420 static void jlink_runtest(int num_cycles)
 421 {
 422         int i;
 423
 424         tap_state_t saved_end_state = tap_get_end_state();
 425
 426         jlink_tap_ensure_space(1,num_cycles + 16);
 427
 428         /* only do a state_move when we're not already in IDLE */
 429         if (tap_get_state() != TAP_IDLE)
 430         {
 431                 jlink_end_state(TAP_IDLE);
 432                 jlink_state_move();
 433 //              num_cycles--;
 434         }
 435
 436         /* execute num_cycles */
 437         for (i = 0; i < num_cycles; i++)
 438         {
 439                 jlink_tap_append_step(0, 0);
 440         }
 441
 442         /* finish in end_state */
 443         jlink_end_state(saved_end_state);
 444         if (tap_get_state() != tap_get_end_state())
 445         {
 446                 jlink_state_move();
 447         }
 448 }
 449
 450 static void jlink_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, scan_command_t *command)
 451 {
 452         tap_state_t saved_end_state;
 453
 454         jlink_tap_ensure_space(1, scan_size + 16);
 455
 456         saved_end_state = tap_get_end_state();
 457
 458         /* Move to appropriate scan state */
 459         jlink_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
 460
 461         /* Only move if we're not already there */
 462         if (tap_get_state() != tap_get_end_state())
 463                 jlink_state_move();
 464
 465         jlink_end_state(saved_end_state);
 466
 467         /* Scan */
 468         jlink_tap_append_scan(scan_size, buffer, command);
 469
 470         /* We are in Exit1, go to Pause */
 471         jlink_tap_append_step(0, 0);
 472
 473         tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
 474
 475         if (tap_get_state() != tap_get_end_state())
 476         {
 477                 jlink_state_move();
 478         }
 479 }
 480
 481 static void jlink_reset(int trst, int srst)
 482 {
 483         LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 484
 485         /* Signals are active low */
 486         if (srst == 0)
 487         {
 488                 jlink_simple_command(EMU_CMD_HW_RESET1);
 489         }
 490         if (srst == 1)
 491         {
 492                 jlink_simple_command(EMU_CMD_HW_RESET0);
 493         }
 494
 495         if (trst == 1)
 496         {
 497                 jlink_simple_command(EMU_CMD_HW_TRST0);
 498         }
 499         if (trst == 0)
 500         {
 501                 jlink_simple_command(EMU_CMD_HW_TRST1);
 502                 jtag_sleep(5000);
 503                 jlink_end_state(TAP_RESET);
 504                 jlink_state_move();
 505         }
 506 }
 507
 508 static void jlink_simple_command(uint8_t command)
 509 {
 510         int result;
 511
 512         DEBUG_JTAG_IO("0x%02x", command);
 513
 514         usb_out_buffer[0] = command;
 515         result = jlink_usb_write(jlink_jtag_handle, 1);
 516
 517         if (result != 1)
 518         {
 519                 LOG_ERROR("J-Link command 0x%02x failed (%d)", command, result);
 520         }
 521 }
 522
 523 static int jlink_get_status(void)
 524 {
 525         int result;
 526
 527         jlink_simple_command(EMU_CMD_GET_STATE);
 528
 529         result = jlink_usb_read(jlink_jtag_handle, 8);
 530         if (result != 8)
 531         {
 532                 LOG_ERROR("J-Link command EMU_CMD_GET_STATE failed (%d)\n", result);
 533                 return ERROR_JTAG_DEVICE_ERROR;
 534         }
 535
 536         int vref = usb_in_buffer[0] + (usb_in_buffer[1] << 8);
 537         LOG_INFO("Vref = %d.%d TCK = %d TDI = %d TDO = %d TMS = %d SRST = %d TRST = %d\n", \
 538                 vref / 1000, vref % 1000, \
 539                 usb_in_buffer[2], usb_in_buffer[3], usb_in_buffer[4], \
 540                 usb_in_buffer[5], usb_in_buffer[6], usb_in_buffer[7]);
 541
 542         if (vref < 1500)
 543                 LOG_ERROR("Vref too low. Check Target Power\n");
 544
 545         return ERROR_OK;
 546 }
 547
 548 static int jlink_get_version_info(void)
 549 {
 550         int result;
 551         int len;
 552         uint32_t jlink_caps, jlink_max_size;
 553
 554         /* query hardware version */
 555         jlink_simple_command(EMU_CMD_VERSION);
 556
 557         result = jlink_usb_read(jlink_jtag_handle, 2);
 558         if (2 != result)
 559         {
 560                 LOG_ERROR("J-Link command EMU_CMD_VERSION failed (%d)\n", result);
 561                 return ERROR_JTAG_DEVICE_ERROR;
 562         }
 563
 564         len = buf_get_u32(usb_in_buffer, 0, 16);
 565         if (len > JLINK_IN_BUFFER_SIZE)
 566         {
 567                 LOG_ERROR("J-Link command EMU_CMD_VERSION impossible return length 0x%0x", len);
 568                 len = JLINK_IN_BUFFER_SIZE;
 569         }
 570
 571         result = jlink_usb_read(jlink_jtag_handle, len);
 572         if (result != len)
 573         {
 574                 LOG_ERROR("J-Link command EMU_CMD_VERSION failed (%d)\n", result);
 575                 return ERROR_JTAG_DEVICE_ERROR;
 576         }
 577
 578         usb_in_buffer[result] = 0;
 579         LOG_INFO("%s", (char *)usb_in_buffer);
 580
 581         /* query hardware capabilities */
 582         jlink_simple_command(EMU_CMD_GET_CAPS);
 583
 584         result = jlink_usb_read(jlink_jtag_handle, 4);
 585         if (4 != result)
 586         {
 587                 LOG_ERROR("J-Link command EMU_CMD_GET_CAPS failed (%d)\n", result);
 588                 return ERROR_JTAG_DEVICE_ERROR;
 589         }
 590
 591         jlink_caps = buf_get_u32(usb_in_buffer, 0, 32);
 592         LOG_INFO("JLink caps 0x%x", (unsigned)jlink_caps);
 593
 594         if (jlink_caps & (1 << EMU_CAP_GET_HW_VERSION))
 595         {
 596                 /* query hardware version */
 597                 jlink_simple_command(EMU_CMD_GET_HW_VERSION);
 598
 599                 result = jlink_usb_read(jlink_jtag_handle, 4);
 600                 if (4 != result)
 601                 {
 602                         LOG_ERROR("J-Link command EMU_CMD_GET_HW_VERSION failed (%d)\n", result);
 603                         return ERROR_JTAG_DEVICE_ERROR;
 604                 }
 605
 606                 uint32_t jlink_hw_version = buf_get_u32(usb_in_buffer, 0, 32);
 607                 uint32_t major_revision = (jlink_hw_version / 10000) % 100;
 608                 if (major_revision >= 5)
 609                         jlink_hw_jtag_version = 3;
 610
 611                 LOG_INFO("JLink hw version %i", (int)jlink_hw_version);
 612         }
 613
 614         if (jlink_caps & (1 << EMU_CAP_GET_MAX_BLOCK_SIZE))
 615         {
 616                 /* query hardware maximum memory block */
 617                 jlink_simple_command(EMU_CMD_GET_MAX_MEM_BLOCK);
 618
 619                 result = jlink_usb_read(jlink_jtag_handle, 4);
 620                 if (4 != result)
 621                 {
 622                         LOG_ERROR("J-Link command EMU_CMD_GET_MAX_MEM_BLOCK failed (%d)\n", result);
 623                         return ERROR_JTAG_DEVICE_ERROR;
 624                 }
 625
 626                 jlink_max_size = buf_get_u32(usb_in_buffer, 0, 32);
 627                 LOG_INFO("JLink max mem block %i", (int)jlink_max_size);
 628         }
 629
 630         return ERROR_OK;
 631 }
 632
 633 static int jlink_handle_jlink_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 634 {
 635         if (jlink_get_version_info() == ERROR_OK)
 636         {
 637                 /* attempt to get status */
 638                 jlink_get_status();
 639         }
 640
 641         return ERROR_OK;
 642 }
 643
 644 static int jlink_handle_jlink_hw_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
 645 {
 646         switch (argc) {
 647         case 0:
 648                 command_print(cmd_ctx, "jlink hw jtag  %i", jlink_hw_jtag_version);
 649                 break;
 650         case 1: {
 651                 int request_version = atoi(args[0]);
 652                 switch (request_version) {
 653                 case 2: case 3:
 654                         jlink_hw_jtag_version = request_version;
 655                         break;
 656                 default:
 657                         return ERROR_COMMAND_SYNTAX_ERROR;
 658                 }
 659                 break;
 660         }
 661         default:
 662                 return ERROR_COMMAND_SYNTAX_ERROR;
 663         }
 664
 665         return ERROR_OK;
 666 }
 667
 668 /***************************************************************************/
 669 /* J-Link tap functions */
 670
 671
 672 static unsigned tap_length=0;
 673 static uint8_t tms_buffer[JLINK_TAP_BUFFER_SIZE];
 674 static uint8_t tdi_buffer[JLINK_TAP_BUFFER_SIZE];
 675 static uint8_t tdo_buffer[JLINK_TAP_BUFFER_SIZE];
 676
 677 typedef struct
 678 {
 679         int first;      /* First bit position in tdo_buffer to read */
 680         int length; /* Number of bits to read */
 681         scan_command_t *command; /* Corresponding scan command */
 682         uint8_t *buffer;
 683 } pending_scan_result_t;
 684
 685 #define MAX_PENDING_SCAN_RESULTS 256
 686
 687 static int pending_scan_results_length;
 688 static pending_scan_result_t pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
 689
 690 static void jlink_tap_init(void)
 691 {
 692         tap_length = 0;
 693         pending_scan_results_length = 0;
 694 }
 695
 696 static void jlink_tap_ensure_space(int scans, int bits)
 697 {
 698         int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
 699         int available_bits = JLINK_TAP_BUFFER_SIZE * 8 - tap_length - 32;
 700
 701         if (scans > available_scans || bits > available_bits)
 702         {
 703                 jlink_tap_execute();
 704         }
 705 }
 706
 707 static void jlink_tap_append_step(int tms, int tdi)
 708 {
 709         int index = tap_length / 8;
 710
 711         if (index >= JLINK_TAP_BUFFER_SIZE)
 712         {
 713                 LOG_ERROR("jlink_tap_append_step: overflow");
 714                 *(uint32_t *)0xFFFFFFFF = 0;
 715                 exit(-1);
 716         }
 717
 718         int bit_index = tap_length % 8;
 719         uint8_t bit = 1 << bit_index;
 720
 721         // we do not pad TMS, so be sure to initialize all bits
 722         if (0 == bit_index)
 723         {
 724                 tms_buffer[index] = tdi_buffer[index] = 0;
 725         }
 726
 727         if (tms)
 728                 tms_buffer[index] |= bit;
 729         else
 730                 tms_buffer[index] &= ~bit;
 731
 732         if (tdi)
 733                 tdi_buffer[index] |= bit;
 734         else
 735                 tdi_buffer[index] &= ~bit;
 736
 737         tap_length++;
 738 }
 739
 740 static void jlink_tap_append_scan(int length, uint8_t *buffer, scan_command_t *command)
 741 {
 742         pending_scan_result_t *pending_scan_result =
 743                 &pending_scan_results_buffer[pending_scan_results_length];
 744         int i;
 745
 746         pending_scan_result->first = tap_length;
 747         pending_scan_result->length = length;
 748         pending_scan_result->command = command;
 749         pending_scan_result->buffer = buffer;
 750
 751         for (i = 0; i < length; i++)
 752         {
 753                 int tms = (i < (length - 1)) ? 0 : 1;
 754                 int tdi = (buffer[i / 8] & (1 << (i % 8))) != 0;
 755                 jlink_tap_append_step(tms, tdi);
 756         }
 757         pending_scan_results_length++;
 758 }
 759
 760 /* Pad and send a tap sequence to the device, and receive the answer.
 761  * For the purpose of padding we assume that we are in idle or pause state. */
 762 static int jlink_tap_execute(void)
 763 {
 764         int byte_length;
 765         int i;
 766         int result;
 767
 768         if (!tap_length)
 769                 return ERROR_OK;
 770
 771         /* JLink returns an extra NULL in packet when size of in message is a multiple of 64, creates problems with usb comms */
 772         /* WARNING This will interfere with tap state counting */
 773         while ((TAP_SCAN_BYTES(tap_length)%64)==0)
 774         {
 775                 jlink_tap_append_step((tap_get_state() == TAP_RESET)?1:0, 0);
 776         }
 777
 778         // number of full bytes (plus one if some would be left over)
 779         byte_length = TAP_SCAN_BYTES(tap_length);
 780
 781         bool use_jtag3 = jlink_hw_jtag_version >= 3;
 782         usb_out_buffer[0] = use_jtag3 ? EMU_CMD_HW_JTAG3 : EMU_CMD_HW_JTAG2;
 783         usb_out_buffer[1] = 0;
 784         usb_out_buffer[2] = (tap_length >> 0) & 0xff;
 785         usb_out_buffer[3] = (tap_length >> 8) & 0xff;
 786         memcpy(usb_out_buffer + 4, tms_buffer, byte_length);
 787         memcpy(usb_out_buffer + 4 + byte_length, tdi_buffer, byte_length);
 788
 789         jlink_last_state = jtag_debug_state_machine(tms_buffer, tdi_buffer,
 790                         tap_length, jlink_last_state);
 791
 792         result = jlink_usb_message(jlink_jtag_handle, 4 + 2 * byte_length, byte_length);
 793         if (result != byte_length)
 794         {
 795                 LOG_ERROR("jlink_tap_execute, wrong result %d (expected %d)", result, byte_length);
 796                 jlink_tap_init();
 797                 return ERROR_JTAG_QUEUE_FAILED;
 798         }
 799
 800         memcpy(tdo_buffer, usb_in_buffer, byte_length);
 801
 802         for (i = 0; i < pending_scan_results_length; i++)
 803         {
 804                 pending_scan_result_t *pending_scan_result = &pending_scan_results_buffer[i];
 805                 uint8_t *buffer = pending_scan_result->buffer;
 806                 int length = pending_scan_result->length;
 807                 int first = pending_scan_result->first;
 808                 scan_command_t *command = pending_scan_result->command;
 809
 810                 /* Copy to buffer */
 811                 buf_set_buf(tdo_buffer, first, buffer, 0, length);
 812
 813                 DEBUG_JTAG_IO("pending scan result, length = %d", length);
 814
 815 #ifdef _DEBUG_USB_COMMS_
 816                 jlink_debug_buffer(buffer, TAP_SCAN_BYTES(length));
 817 #endif
 818
 819                 if (jtag_read_buffer(buffer, command) != ERROR_OK)
 820                 {
 821                         jlink_tap_init();
 822                         return ERROR_JTAG_QUEUE_FAILED;
 823                 }
 824
 825                 if (pending_scan_result->buffer != NULL)
 826                 {
 827                         free(pending_scan_result->buffer);
 828                 }
 829         }
 830
 831         jlink_tap_init();
 832         return ERROR_OK;
 833 }
 834
 835 /*****************************************************************************/
 836 /* JLink USB low-level functions */
 837
 838 static jlink_jtag_t* jlink_usb_open()
 839 {
 840         struct usb_bus *busses;
 841         struct usb_bus *bus;
 842         struct usb_device *dev;
 843
 844         jlink_jtag_t *result;
 845
 846         result = (jlink_jtag_t*) malloc(sizeof(jlink_jtag_t));
 847
 848         usb_init();
 849         usb_find_busses();
 850         usb_find_devices();
 851
 852         busses = usb_get_busses();
 853
 854         /* find jlink_jtag device in usb bus */
 855
 856         for (bus = busses; bus; bus = bus->next)
 857         {
 858                 for (dev = bus->devices; dev; dev = dev->next)
 859                 {
 860                         if ((dev->descriptor.idVendor == VID) && (dev->descriptor.idProduct == PID))
 861                         {
 862                                 result->usb_handle = usb_open(dev);
 863
 864                                 /* usb_set_configuration required under win32 */
 865                                 usb_set_configuration(result->usb_handle, dev->config[0].bConfigurationValue);
 866                                 usb_claim_interface(result->usb_handle, 0);
 867
 868 #if 0
 869                                 /*
 870                                  * This makes problems under Mac OS X. And is not needed
 871                                  * under Windows. Hopefully this will not break a linux build
 872                                  */
 873                                 usb_set_altinterface(result->usb_handle, 0);
 874 #endif
 875                                 struct usb_interface *iface = dev->config->interface;
 876                                 struct usb_interface_descriptor *desc = iface->altsetting;
 877                                 for (int i = 0; i < desc->bNumEndpoints; i++)
 878                                 {
 879                                         uint8_t epnum = desc->endpoint[i].bEndpointAddress;
 880                                         bool is_input = epnum & 0x80;
 881                                         LOG_DEBUG("usb ep %s %02x", is_input ? "in" : "out", epnum);
 882                                         if (is_input)
 883                                                 jlink_read_ep = epnum;
 884                                         else
 885                                                 jlink_write_ep = epnum;
 886                                 }
 887
 888                                 return result;
 889                         }
 890                 }
 891         }
 892
 893         free(result);
 894         return NULL;
 895 }
 896
 897 static void jlink_usb_close(jlink_jtag_t *jlink_jtag)
 898 {
 899         usb_close(jlink_jtag->usb_handle);
 900         free(jlink_jtag);
 901 }
 902
 903 /* Send a message and receive the reply. */
 904 static int jlink_usb_message(jlink_jtag_t *jlink_jtag, int out_length, int in_length)
 905 {
 906         int result;
 907
 908         result = jlink_usb_write(jlink_jtag, out_length);
 909         if (result != out_length)
 910         {
 911                 LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)",
 912                                 out_length, result);
 913                 return ERROR_JTAG_DEVICE_ERROR;
 914         }
 915
 916         result = jlink_usb_read(jlink_jtag, in_length);
 917         if ((result != in_length) && (result != (in_length + 1)))
 918         {
 919                 LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)",
 920                                 in_length, result);
 921                 return ERROR_JTAG_DEVICE_ERROR;
 922         }
 923
 924         if (jlink_hw_jtag_version < 3)
 925                 return result;
 926
 927         int result2 = ERROR_OK;
 928         if (result == in_length)
 929         {
 930                 /* Must read the result from the EMU too */
 931                 result2 = jlink_usb_read_emu_result(jlink_jtag);
 932                 if (1 != result2)
 933                 {
 934                         LOG_ERROR("jlink_usb_read_emu_result retried requested=1, result=%d, in_length=%i", result2,in_length);
 935                         /* Try again once, should only happen if (in_length%64==0) */
 936                         result2 = jlink_usb_read_emu_result(jlink_jtag);
 937                         if (1 != result2)
 938                         {
 939                                 LOG_ERROR("jlink_usb_read_emu_result failed "
 940                                         "(requested=1, result=%d)", result2);
 941                                 return ERROR_JTAG_DEVICE_ERROR;
 942                         }
 943                 }
 944
 945                 /* Check the result itself */
 946                 result2 = usb_emu_result_buffer[0];
 947         }
 948         else
 949         {
 950                 /* Save the result, then remove it from return value */
 951                 result2 = usb_in_buffer[result--];
 952         }
 953
 954         if (result2)
 955         {
 956                 LOG_ERROR("jlink_usb_message failed with result=%d)", result2);
 957                 return ERROR_JTAG_DEVICE_ERROR;
 958         }
 959
 960         return result;
 961 }
 962
 963 /* calls the given usb_bulk_* function, allowing for the data to trickle in with some timeouts  */
 964 static int usb_bulk_with_retries(
 965                 int (*f)(usb_dev_handle *, int, char *, int, int),
 966                 usb_dev_handle *dev, int ep,
 967                 char *bytes, int size, int timeout)
 968 {
 969         int tries = 3, count = 0;
 970
 971         while (tries && (count < size))
 972         {
 973                 int result = f(dev, ep, bytes + count, size - count, timeout);
 974                 if (result > 0)
 975                         count += result;
 976                 else if ((-ETIMEDOUT != result) || !--tries)
 977                         return result;
 978         }
 979         return count;
 980 }
 981
 982 static int wrap_usb_bulk_write(usb_dev_handle *dev, int ep,
 983                                char *buff, int size, int timeout)
 984 {
 985         /* usb_bulk_write() takes const char *buff */
 986         return usb_bulk_write(dev, ep, buff, size, timeout);
 987 }
 988
 989 static inline int usb_bulk_write_ex(usb_dev_handle *dev, int ep,
 990                 char *bytes, int size, int timeout)
 991 {
 992         return usb_bulk_with_retries(&wrap_usb_bulk_write,
 993                         dev, ep, bytes, size, timeout);
 994 }
 995
 996 static inline int usb_bulk_read_ex(usb_dev_handle *dev, int ep,
 997                 char *bytes, int size, int timeout)
 998 {
 999         return usb_bulk_with_retries(&usb_bulk_read,
1000                         dev, ep, bytes, size, timeout);
1001 }
1002
1003 /* Write data from out_buffer to USB. */
1004 static int jlink_usb_write(jlink_jtag_t *jlink_jtag, int out_length)
1005 {
1006         int result;
1007
1008         if (out_length > JLINK_OUT_BUFFER_SIZE)
1009         {
1010                 LOG_ERROR("jlink_jtag_write illegal out_length=%d (max=%d)", out_length, JLINK_OUT_BUFFER_SIZE);
1011                 return -1;
1012         }
1013
1014         result = usb_bulk_write_ex(jlink_jtag->usb_handle, jlink_write_ep,
1015                 (char *)usb_out_buffer, out_length, JLINK_USB_TIMEOUT);
1016
1017         DEBUG_JTAG_IO("jlink_usb_write, out_length = %d, result = %d", out_length, result);
1018
1019 #ifdef _DEBUG_USB_COMMS_
1020         jlink_debug_buffer(usb_out_buffer, out_length);
1021 #endif
1022         return result;
1023 }
1024
1025 /* Read data from USB into in_buffer. */
1026 static int jlink_usb_read(jlink_jtag_t *jlink_jtag, int expected_size)
1027 {
1028         int result = usb_bulk_read_ex(jlink_jtag->usb_handle, jlink_read_ep,
1029                 (char *)usb_in_buffer, expected_size, JLINK_USB_TIMEOUT);
1030
1031         DEBUG_JTAG_IO("jlink_usb_read, result = %d", result);
1032
1033 #ifdef _DEBUG_USB_COMMS_
1034         jlink_debug_buffer(usb_in_buffer, result);
1035 #endif
1036         return result;
1037 }
1038
1039 /* Read the result from the previous EMU cmd into result_buffer. */
1040 static int jlink_usb_read_emu_result(jlink_jtag_t *jlink_jtag)
1041 {
1042         int result = usb_bulk_read_ex(jlink_jtag->usb_handle, jlink_read_ep,
1043                 (char *)usb_emu_result_buffer, 1 /* JLINK_EMU_RESULT_BUFFER_SIZE */,
1044                 JLINK_USB_TIMEOUT);
1045
1046         DEBUG_JTAG_IO("jlink_usb_read_result, result = %d", result);
1047
1048 #ifdef _DEBUG_USB_COMMS_
1049         jlink_debug_buffer(usb_emu_result_buffer, result);
1050 #endif
1051         return result;
1052 }
1053
1054 #ifdef _DEBUG_USB_COMMS_
1055 #define BYTES_PER_LINE  16
1056
1057 static void jlink_debug_buffer(uint8_t *buffer, int length)
1058 {
1059         char line[81];
1060         char s[4];
1061         int i;
1062         int j;
1063
1064         for (i = 0; i < length; i += BYTES_PER_LINE)
1065         {
1066                 snprintf(line, 5, "%04x", i);
1067                 for (j = i; j < i + BYTES_PER_LINE && j < length; j++)
1068                 {
1069                         snprintf(s, 4, " %02x", buffer[j]);
1070                         strcat(line, s);
1071                 }
1072                 LOG_DEBUG("%s", line);
1073         }
1074 }
1075 #endif
1076