src/jtag/drivers/arm-jtag-ew.c

   1 /***************************************************************************
   2  *   Copyright (C) 2009 by Dimitar Dimitrov <dinuxbg@gmail.com>            *
   3  *   based on Dominic Rath's and Benedikt Sauter's usbprog.c               *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <jtag/interface.h>
  26 #include <jtag/commands.h>
  27 #include <usb.h>
  28 #include "usb_common.h"
  29
  30
  31 #define USB_VID                                         0x15ba
  32 #define USB_PID                                         0x001e
  33
  34 #define ARMJTAGEW_EPT_BULK_OUT          0x01u
  35 #define ARMJTAGEW_EPT_BULK_IN           0x82u
  36
  37 #define ARMJTAGEW_USB_TIMEOUT           2000
  38
  39 #define ARMJTAGEW_IN_BUFFER_SIZE        (4*1024)
  40 #define ARMJTAGEW_OUT_BUFFER_SIZE       (4*1024)
  41
  42
  43 /* USB command request codes. */
  44 #define CMD_GET_VERSION                         0x00
  45 #define CMD_SELECT_DPIMPL                       0x10
  46 #define CMD_SET_TCK_FREQUENCY           0x11
  47 #define CMD_GET_TCK_FREQUENCY           0x12
  48 #define CMD_MEASURE_MAX_TCK_FREQ        0x15
  49 #define CMD_MEASURE_RTCK_RESPONSE       0x16
  50 #define CMD_TAP_SHIFT                           0x17
  51 #define CMD_SET_TAPHW_STATE                     0x20
  52 #define CMD_GET_TAPHW_STATE                     0x21
  53 #define CMD_TGPWR_SETUP                         0x22
  54
  55 /* Global USB buffers */
  56 static uint8_t usb_in_buffer[ARMJTAGEW_IN_BUFFER_SIZE];
  57 static uint8_t usb_out_buffer[ARMJTAGEW_OUT_BUFFER_SIZE];
  58
  59 /* Queue command functions */
  60 static void armjtagew_end_state(tap_state_t state);
  61 static void armjtagew_state_move(void);
  62 static void armjtagew_path_move(int num_states, tap_state_t *path);
  63 static void armjtagew_runtest(int num_cycles);
  64 static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command);
  65 static void armjtagew_reset(int trst, int srst);
  66 //static void armjtagew_simple_command(uint8_t command);
  67 static int armjtagew_get_status(void);
  68
  69 /* tap buffer functions */
  70 static void armjtagew_tap_init(void);
  71 static int armjtagew_tap_execute(void);
  72 static void armjtagew_tap_ensure_space(int scans, int bits);
  73 static void armjtagew_tap_append_step(int tms, int tdi);
  74 static void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command);
  75
  76 /* ARM-JTAG-EW lowlevel functions */
  77 struct armjtagew {
  78         struct usb_dev_handle* usb_handle;
  79 };
  80
  81 static struct armjtagew *armjtagew_usb_open(void);
  82 static void armjtagew_usb_close(struct armjtagew *armjtagew);
  83 static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, int in_length);
  84 static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length);
  85 static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length);
  86
  87 /* helper functions */
  88 static int armjtagew_get_version_info(void);
  89
  90 #ifdef _DEBUG_USB_COMMS_
  91 static void armjtagew_debug_buffer(uint8_t *buffer, int length);
  92 #endif
  93
  94 static struct armjtagew* armjtagew_handle;
  95
  96
  97
  98 /***************************************************************************/
  99 /* External interface implementation */
 100
 101 static int armjtagew_execute_queue(void)
 102 {
 103         struct jtag_command *cmd = jtag_command_queue;
 104         int scan_size;
 105         enum scan_type type;
 106         uint8_t *buffer;
 107
 108         while (cmd != NULL)
 109         {
 110                 switch (cmd->type)
 111                 {
 112                         case JTAG_RUNTEST:
 113                                 DEBUG_JTAG_IO("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, \
 114                                         cmd->cmd.runtest->end_state);
 115
 116                                 armjtagew_end_state(cmd->cmd.runtest->end_state);
 117                                 armjtagew_runtest(cmd->cmd.runtest->num_cycles);
 118                                 break;
 119
 120                         case JTAG_TLR_RESET:
 121                                 DEBUG_JTAG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
 122
 123                                 armjtagew_end_state(cmd->cmd.statemove->end_state);
 124                                 armjtagew_state_move();
 125                                 break;
 126
 127                         case JTAG_PATHMOVE:
 128                                 DEBUG_JTAG_IO("pathmove: %i states, end in %i", \
 129                                         cmd->cmd.pathmove->num_states, \
 130                                         cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
 131
 132                                 armjtagew_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
 133                                 break;
 134
 135                         case JTAG_SCAN:
 136                                 DEBUG_JTAG_IO("scan end in %i", cmd->cmd.scan->end_state);
 137
 138                                 armjtagew_end_state(cmd->cmd.scan->end_state);
 139
 140                                 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
 141                                 DEBUG_JTAG_IO("scan input, length = %d", scan_size);
 142
 143 #ifdef _DEBUG_USB_COMMS_
 144                                 armjtagew_debug_buffer(buffer, (scan_size + 7) / 8);
 145 #endif
 146                                 type = jtag_scan_type(cmd->cmd.scan);
 147                                 armjtagew_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size, cmd->cmd.scan);
 148                                 break;
 149
 150                         case JTAG_RESET:
 151                                 DEBUG_JTAG_IO("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 152
 153                                 armjtagew_tap_execute();
 154
 155                                 if (cmd->cmd.reset->trst == 1)
 156                                 {
 157                                         tap_set_state(TAP_RESET);
 158                                 }
 159                                 armjtagew_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 160                                 break;
 161
 162                         case JTAG_SLEEP:
 163                                 DEBUG_JTAG_IO("sleep %i", cmd->cmd.sleep->us);
 164                                 armjtagew_tap_execute();
 165                                 jtag_sleep(cmd->cmd.sleep->us);
 166                                 break;
 167
 168                         default:
 169                                 LOG_ERROR("BUG: unknown JTAG command type encountered");
 170                                 exit(-1);
 171                 }
 172                 cmd = cmd->next;
 173         }
 174
 175         return armjtagew_tap_execute();
 176 }
 177
 178
 179 /* Sets speed in kHz. */
 180 static int armjtagew_speed(int speed)
 181 {
 182     int result;
 183     int speed_real;
 184
 185
 186     usb_out_buffer[0] = CMD_SET_TCK_FREQUENCY;
 187         buf_set_u32(usb_out_buffer + 1, 0, 32, speed);
 188
 189     result = armjtagew_usb_message(armjtagew_handle, 4, 4);
 190
 191     if (result < 0)
 192     {
 193         LOG_ERROR("ARM-JTAG-EW setting speed failed (%d)", result);
 194         return ERROR_JTAG_DEVICE_ERROR;
 195     }
 196
 197         usb_out_buffer[0] = CMD_GET_TCK_FREQUENCY;
 198     result = armjtagew_usb_message(armjtagew_handle, 1, 4);
 199         speed_real = (int)buf_get_u32(usb_in_buffer,0,32);
 200         if (result < 0)
 201         {
 202         LOG_ERROR("ARM-JTAG-EW getting speed failed (%d)", result);
 203         return ERROR_JTAG_DEVICE_ERROR;
 204         }
 205         else
 206         {
 207         LOG_INFO("Requested speed %dkHz, emulator reported %dkHz.", speed, speed_real);
 208         }
 209
 210     return ERROR_OK;
 211 }
 212
 213
 214 static int armjtagew_khz(int khz, int *jtag_speed)
 215 {
 216         *jtag_speed = khz;
 217
 218         return ERROR_OK;
 219 }
 220
 221 static int armjtagew_init(void)
 222 {
 223         int check_cnt;
 224
 225         armjtagew_handle = armjtagew_usb_open();
 226
 227         if (armjtagew_handle == 0)
 228         {
 229                 LOG_ERROR("Cannot find ARM-JTAG-EW Interface! Please check connection and permissions.");
 230                 return ERROR_JTAG_INIT_FAILED;
 231         }
 232
 233         check_cnt = 0;
 234         while (check_cnt < 3)
 235         {
 236                 if (armjtagew_get_version_info() == ERROR_OK)
 237                 {
 238                         /* attempt to get status */
 239                         armjtagew_get_status();
 240                         break;
 241                 }
 242
 243                 check_cnt++;
 244         }
 245
 246         if (check_cnt == 3)
 247         {
 248                 LOG_INFO("ARM-JTAG-EW initial read failed, don't worry");
 249         }
 250
 251         LOG_INFO("ARM-JTAG-EW JTAG Interface ready");
 252
 253         armjtagew_reset(0, 0);
 254         armjtagew_tap_init();
 255
 256         return ERROR_OK;
 257 }
 258
 259 static int armjtagew_quit(void)
 260 {
 261         armjtagew_usb_close(armjtagew_handle);
 262         return ERROR_OK;
 263 }
 264
 265 /***************************************************************************/
 266 /* Queue command implementations */
 267
 268 static void armjtagew_end_state(tap_state_t state)
 269 {
 270         if (tap_is_state_stable(state))
 271         {
 272                 tap_set_end_state(state);
 273         }
 274         else
 275         {
 276                 LOG_ERROR("BUG: %i is not a valid end state", state);
 277                 exit(-1);
 278         }
 279 }
 280
 281 /* Goes to the end state. */
 282 static void armjtagew_state_move(void)
 283 {
 284         int i;
 285         int tms = 0;
 286         uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
 287         int tms_count = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
 288
 289         for (i = 0; i < tms_count; i++)
 290         {
 291                 tms = (tms_scan >> i) & 1;
 292                 armjtagew_tap_append_step(tms, 0);
 293         }
 294
 295         tap_set_state(tap_get_end_state());
 296 }
 297
 298 static void armjtagew_path_move(int num_states, tap_state_t *path)
 299 {
 300         int i;
 301
 302         for (i = 0; i < num_states; i++)
 303         {
 304                 /*
 305                  * TODO: The ARM-JTAG-EW hardware delays TDI with 3 TCK cycles when in RTCK mode.
 306                  * Either handle that here, or update the documentation with examples
 307                  * how to fix that in the configuration files.
 308                  */
 309                 if (path[i] == tap_state_transition(tap_get_state(), false))
 310                 {
 311                         armjtagew_tap_append_step(0, 0);
 312                 }
 313                 else if (path[i] == tap_state_transition(tap_get_state(), true))
 314                 {
 315                         armjtagew_tap_append_step(1, 0);
 316                 }
 317                 else
 318                 {
 319                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition", tap_state_name(tap_get_state()), tap_state_name(path[i]));
 320                         exit(-1);
 321                 }
 322
 323                 tap_set_state(path[i]);
 324         }
 325
 326         tap_set_end_state(tap_get_state());
 327 }
 328
 329 static void armjtagew_runtest(int num_cycles)
 330 {
 331         int i;
 332
 333         tap_state_t saved_end_state = tap_get_end_state();
 334
 335         /* only do a state_move when we're not already in IDLE */
 336         if (tap_get_state() != TAP_IDLE)
 337         {
 338                 armjtagew_end_state(TAP_IDLE);
 339                 armjtagew_state_move();
 340         }
 341
 342         /* execute num_cycles */
 343         for (i = 0; i < num_cycles; i++)
 344         {
 345                 armjtagew_tap_append_step(0, 0);
 346         }
 347
 348         /* finish in end_state */
 349         armjtagew_end_state(saved_end_state);
 350         if (tap_get_state() != tap_get_end_state())
 351         {
 352                 armjtagew_state_move();
 353         }
 354 }
 355
 356 static void armjtagew_scan(bool ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command)
 357 {
 358         tap_state_t saved_end_state;
 359
 360         armjtagew_tap_ensure_space(1, scan_size + 8);
 361
 362         saved_end_state = tap_get_end_state();
 363
 364         /* Move to appropriate scan state */
 365         armjtagew_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
 366
 367         armjtagew_state_move();
 368         armjtagew_end_state(saved_end_state);
 369
 370         /* Scan */
 371         armjtagew_tap_append_scan(scan_size, buffer, command);
 372
 373         /* We are in Exit1, go to Pause */
 374         armjtagew_tap_append_step(0, 0);
 375
 376         tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
 377
 378         if (tap_get_state() != tap_get_end_state())
 379         {
 380                 armjtagew_state_move();
 381         }
 382 }
 383
 384 static void armjtagew_reset(int trst, int srst)
 385 {
 386         const uint8_t trst_mask = (1u << 5);
 387         const uint8_t srst_mask = (1u << 6);
 388         uint8_t val = 0;
 389         uint8_t outp_en = 0;
 390         uint8_t change_mask = 0;
 391         int result;
 392
 393         LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 394
 395         if (srst == 0)
 396         {
 397                 val |= srst_mask;
 398                 outp_en &= ~srst_mask;          /* tristate */
 399                 change_mask |= srst_mask;
 400         }
 401         else if (srst == 1)
 402         {
 403                 val &= ~srst_mask;
 404                 outp_en |= srst_mask;
 405                 change_mask |= srst_mask;
 406         }
 407
 408         if (trst == 0)
 409         {
 410                 val |= trst_mask;
 411                 outp_en &= ~trst_mask;          /* tristate */
 412                 change_mask |= trst_mask;
 413         }
 414         else if (trst == 1)
 415         {
 416                 val &= ~trst_mask;
 417                 outp_en |= trst_mask;
 418                 change_mask |= trst_mask;
 419         }
 420
 421         usb_out_buffer[0] = CMD_SET_TAPHW_STATE;
 422         usb_out_buffer[1] = val;
 423         usb_out_buffer[2] = outp_en;
 424         usb_out_buffer[3] = change_mask;
 425         result = armjtagew_usb_write(armjtagew_handle, 4);
 426         if (result != 4)
 427         {
 428                 LOG_ERROR("ARM-JTAG-EW TRST/SRST pin set failed failed (%d)", result);
 429         }
 430 }
 431
 432
 433 static int armjtagew_get_status(void)
 434 {
 435         int result;
 436
 437         usb_out_buffer[0] = CMD_GET_TAPHW_STATE;
 438         result = armjtagew_usb_message(armjtagew_handle, 1, 12);
 439
 440         if (result == 0)
 441         {
 442                 unsigned int u_tg = buf_get_u32(usb_in_buffer, 0, 16);
 443                 LOG_INFO("U_tg = %d mV, U_aux = %d mV, U_tgpwr = %d mV, I_tgpwr = %d mA, D1 = %d, Target power %s %s",
 444                          (int)(buf_get_u32(usb_in_buffer + 0, 0, 16)),
 445                          (int)(buf_get_u32(usb_in_buffer + 2, 0, 16)),
 446                          (int)(buf_get_u32(usb_in_buffer + 4, 0, 16)),
 447                          (int)(buf_get_u32(usb_in_buffer + 6, 0, 16)),
 448                          usb_in_buffer[9],
 449                          usb_in_buffer[11] ? "OVERCURRENT" : "OK",
 450                          usb_in_buffer[10] ? "enabled" : "disabled");
 451
 452                 if (u_tg < 1500)
 453                 {
 454                         LOG_ERROR("Vref too low. Check Target Power");
 455                 }
 456         }
 457         else
 458         {
 459                 LOG_ERROR("ARM-JTAG-EW command CMD_GET_TAPHW_STATE failed (%d)", result);
 460         }
 461
 462         return ERROR_OK;
 463 }
 464
 465 static int armjtagew_get_version_info(void)
 466 {
 467         int result;
 468         char sn[16];
 469         char auxinfo[257];
 470
 471         /* query hardware version */
 472         usb_out_buffer[0] = CMD_GET_VERSION;
 473         result = armjtagew_usb_message(armjtagew_handle, 1, 4 + 15 + 256);
 474
 475         if (result != 0)
 476         {
 477                 LOG_ERROR("ARM-JTAG-EW command CMD_GET_VERSION failed (%d)", result);
 478                 return ERROR_JTAG_DEVICE_ERROR;
 479         }
 480
 481
 482         memcpy(sn, usb_in_buffer + 4, 15);
 483         sn[15] = '\0';
 484         memcpy(auxinfo, usb_in_buffer + 4+15, 256);
 485         auxinfo[256] = '\0';
 486
 487         LOG_INFO("ARM-JTAG-EW firmware version %d.%d, hardware revision %c, SN=%s, Additional info: %s", \
 488                         usb_in_buffer[1], usb_in_buffer[0], \
 489                         isgraph(usb_in_buffer[2]) ? usb_in_buffer[2] : 'X', \
 490                         sn, auxinfo);
 491         return ERROR_OK;
 492 }
 493
 494 COMMAND_HANDLER(armjtagew_handle_armjtagew_info_command)
 495 {
 496         if (armjtagew_get_version_info() == ERROR_OK)
 497         {
 498                 /* attempt to get status */
 499                 armjtagew_get_status();
 500         }
 501
 502         return ERROR_OK;
 503 }
 504
 505 static const struct command_registration armjtagew_command_handlers[] = {
 506         {
 507                 .name = "armjtagew_info",
 508                 .handler = &armjtagew_handle_armjtagew_info_command,
 509                 .mode = COMMAND_EXEC,
 510                 .help = "query armjtagew info",
 511         },
 512         COMMAND_REGISTRATION_DONE
 513 };
 514
 515 struct jtag_interface armjtagew_interface = {
 516         .name = "arm-jtag-ew",
 517         .commands = armjtagew_command_handlers,
 518
 519         .execute_queue = armjtagew_execute_queue,
 520         .speed = armjtagew_speed,
 521         .khz = armjtagew_khz,
 522         .init = armjtagew_init,
 523         .quit = armjtagew_quit,
 524 };
 525
 526 /***************************************************************************/
 527 /* ARM-JTAG-EW tap functions */
 528
 529 /* 2048 is the max value we can use here */
 530 #define ARMJTAGEW_TAP_BUFFER_SIZE 2048
 531
 532 static int tap_length;
 533 static uint8_t tms_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
 534 static uint8_t tdi_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
 535 static uint8_t tdo_buffer[ARMJTAGEW_TAP_BUFFER_SIZE];
 536
 537 struct pending_scan_result {
 538         int first;      /* First bit position in tdo_buffer to read */
 539         int length; /* Number of bits to read */
 540         struct scan_command *command; /* Corresponding scan command */
 541         uint8_t *buffer;
 542 };
 543
 544 #define MAX_PENDING_SCAN_RESULTS 256
 545
 546 static int pending_scan_results_length;
 547 static struct pending_scan_result pending_scan_results_buffer[MAX_PENDING_SCAN_RESULTS];
 548
 549 static int last_tms;
 550
 551 static void armjtagew_tap_init(void)
 552 {
 553         tap_length = 0;
 554         pending_scan_results_length = 0;
 555 }
 556
 557 static void armjtagew_tap_ensure_space(int scans, int bits)
 558 {
 559         int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
 560         int available_bits = ARMJTAGEW_TAP_BUFFER_SIZE * 8 - tap_length;
 561
 562         if (scans > available_scans || bits > available_bits)
 563         {
 564                 armjtagew_tap_execute();
 565         }
 566 }
 567
 568 static void armjtagew_tap_append_step(int tms, int tdi)
 569 {
 570         last_tms = tms;
 571         int index_local = tap_length / 8;
 572
 573         if (index_local < ARMJTAGEW_TAP_BUFFER_SIZE)
 574         {
 575                 int bit_index = tap_length % 8;
 576                 uint8_t bit = 1 << bit_index;
 577
 578                 if (tms)
 579                 {
 580                         tms_buffer[index_local] |= bit;
 581                 }
 582                 else
 583                 {
 584                         tms_buffer[index_local] &= ~bit;
 585                 }
 586
 587                 if (tdi)
 588                 {
 589                         tdi_buffer[index_local] |= bit;
 590                 }
 591                 else
 592                 {
 593                         tdi_buffer[index_local] &= ~bit;
 594                 }
 595
 596                 tap_length++;
 597         }
 598         else
 599         {
 600                 LOG_ERROR("armjtagew_tap_append_step, overflow");
 601         }
 602 }
 603
 604 void armjtagew_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command)
 605 {
 606         struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
 607         int i;
 608
 609         pending_scan_result->first = tap_length;
 610         pending_scan_result->length = length;
 611         pending_scan_result->command = command;
 612         pending_scan_result->buffer = buffer;
 613
 614         for (i = 0; i < length; i++)
 615         {
 616                 armjtagew_tap_append_step((i < length-1 ? 0 : 1), (buffer[i/8] >> (i%8)) & 1);
 617         }
 618         pending_scan_results_length++;
 619 }
 620
 621 /* Pad and send a tap sequence to the device, and receive the answer.
 622  * For the purpose of padding we assume that we are in idle or pause state. */
 623 static int armjtagew_tap_execute(void)
 624 {
 625         int byte_length;
 626         int tms_offset;
 627         int tdi_offset;
 628         int i;
 629         int result;
 630
 631         if (tap_length > 0)
 632         {
 633                 /* Pad last byte so that tap_length is divisible by 8 */
 634                 while (tap_length % 8 != 0)
 635                 {
 636                         /* More of the last TMS value keeps us in the same state,
 637                          * analogous to free-running JTAG interfaces. */
 638                         armjtagew_tap_append_step(last_tms, 0);
 639                 }
 640
 641                 byte_length = tap_length / 8;
 642
 643                 usb_out_buffer[0] = CMD_TAP_SHIFT;
 644                 buf_set_u32(usb_out_buffer + 1, 0, 16, byte_length);
 645
 646                 tms_offset = 3;
 647                 for (i = 0; i < byte_length; i++)
 648                 {
 649                         usb_out_buffer[tms_offset + i] = flip_u32(tms_buffer[i],8);
 650                 }
 651
 652                 tdi_offset = tms_offset + byte_length;
 653                 for (i = 0; i < byte_length; i++)
 654                 {
 655                         usb_out_buffer[tdi_offset + i] = flip_u32(tdi_buffer[i],8);
 656                 }
 657
 658                 result = armjtagew_usb_message(armjtagew_handle, 3 + 2 * byte_length, byte_length + 4);
 659
 660                 if (result == 0)
 661                 {
 662                         int stat_local;
 663
 664                         stat_local = (int)buf_get_u32(usb_in_buffer + byte_length, 0, 32);
 665                         if (stat_local) {
 666                                 LOG_ERROR("armjtagew_tap_execute, emulator returned error code %d for a CMD_TAP_SHIFT command", stat_local);
 667                                 return ERROR_JTAG_QUEUE_FAILED;
 668                         }
 669
 670                         for (i = 0; i < byte_length; i++)
 671                         {
 672                                 tdo_buffer[i] = flip_u32(usb_in_buffer[i],8);
 673                         }
 674
 675                         for (i = 0; i < pending_scan_results_length; i++)
 676                         {
 677                                 struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[i];
 678                                 uint8_t *buffer = pending_scan_result->buffer;
 679                                 int length = pending_scan_result->length;
 680                                 int first = pending_scan_result->first;
 681                                 struct scan_command *command = pending_scan_result->command;
 682
 683                                 /* Copy to buffer */
 684                                 buf_set_buf(tdo_buffer, first, buffer, 0, length);
 685
 686                                 DEBUG_JTAG_IO("pending scan result, length = %d", length);
 687
 688 #ifdef _DEBUG_USB_COMMS_
 689                                 armjtagew_debug_buffer(buffer, byte_length);
 690 #endif
 691
 692                                 if (jtag_read_buffer(buffer, command) != ERROR_OK)
 693                                 {
 694                                         armjtagew_tap_init();
 695                                         return ERROR_JTAG_QUEUE_FAILED;
 696                                 }
 697
 698                                 if (pending_scan_result->buffer != NULL)
 699                                 {
 700                                         free(pending_scan_result->buffer);
 701                                 }
 702                         }
 703                 }
 704                 else
 705                 {
 706                         LOG_ERROR("armjtagew_tap_execute, wrong result %d, expected %d", result, byte_length);
 707                         return ERROR_JTAG_QUEUE_FAILED;
 708                 }
 709
 710                 armjtagew_tap_init();
 711         }
 712
 713         return ERROR_OK;
 714 }
 715
 716 /*****************************************************************************/
 717 /* JLink USB low-level functions */
 718
 719 static struct armjtagew* armjtagew_usb_open()
 720 {
 721         usb_init();
 722
 723         const uint16_t vids[] = { USB_VID, 0 };
 724         const uint16_t pids[] = { USB_PID, 0 };
 725         struct usb_dev_handle *dev;
 726         if (jtag_usb_open(vids, pids, &dev) != ERROR_OK)
 727                 return NULL;
 728
 729         struct armjtagew *result = malloc(sizeof(struct armjtagew));
 730         result->usb_handle = dev;
 731
 732 #if 0
 733         /* usb_set_configuration required under win32 */
 734         usb_set_configuration(dev, dev->config[0].bConfigurationValue);
 735 #endif
 736         usb_claim_interface(dev, 0);
 737 #if 0
 738         /*
 739          * This makes problems under Mac OS X. And is not needed
 740          * under Windows. Hopefully this will not break a linux build
 741          */
 742         usb_set_altinterface(dev, 0);
 743 #endif
 744         return result;
 745 }
 746
 747 static void armjtagew_usb_close(struct armjtagew *armjtagew)
 748 {
 749         usb_close(armjtagew->usb_handle);
 750         free(armjtagew);
 751 }
 752
 753 /* Send a message and receive the reply. */
 754 static int armjtagew_usb_message(struct armjtagew *armjtagew, int out_length, int in_length)
 755 {
 756         int result;
 757
 758         result = armjtagew_usb_write(armjtagew, out_length);
 759         if (result == out_length)
 760         {
 761                 result = armjtagew_usb_read(armjtagew, in_length);
 762                 if (result != in_length)
 763                 {
 764                         LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)", in_length, result);
 765                         return -1;
 766                 }
 767         }
 768         else
 769         {
 770                 LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result);
 771                 return -1;
 772         }
 773         return 0;
 774 }
 775
 776 /* Write data from out_buffer to USB. */
 777 static int armjtagew_usb_write(struct armjtagew *armjtagew, int out_length)
 778 {
 779         int result;
 780
 781         if (out_length > ARMJTAGEW_OUT_BUFFER_SIZE)
 782         {
 783                 LOG_ERROR("armjtagew_write illegal out_length=%d (max=%d)", out_length, ARMJTAGEW_OUT_BUFFER_SIZE);
 784                 return -1;
 785         }
 786
 787         result = usb_bulk_write(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_OUT, \
 788                 (char*)usb_out_buffer, out_length, ARMJTAGEW_USB_TIMEOUT);
 789
 790         DEBUG_JTAG_IO("armjtagew_usb_write, out_length = %d, result = %d", out_length, result);
 791
 792 #ifdef _DEBUG_USB_COMMS_
 793         armjtagew_debug_buffer(usb_out_buffer, out_length);
 794 #endif
 795         return result;
 796 }
 797
 798 /* Read data from USB into in_buffer. */
 799 static int armjtagew_usb_read(struct armjtagew *armjtagew, int exp_in_length)
 800 {
 801         int result = usb_bulk_read(armjtagew->usb_handle, ARMJTAGEW_EPT_BULK_IN, \
 802                 (char*)usb_in_buffer, exp_in_length, ARMJTAGEW_USB_TIMEOUT);
 803
 804         DEBUG_JTAG_IO("armjtagew_usb_read, result = %d", result);
 805
 806 #ifdef _DEBUG_USB_COMMS_
 807         armjtagew_debug_buffer(usb_in_buffer, result);
 808 #endif
 809         return result;
 810 }
 811
 812
 813 #ifdef _DEBUG_USB_COMMS_
 814 #define BYTES_PER_LINE  16
 815
 816 static void armjtagew_debug_buffer(uint8_t *buffer, int length)
 817 {
 818         char line[81];
 819         char s[4];
 820         int i;
 821         int j;
 822
 823         for (i = 0; i < length; i += BYTES_PER_LINE)
 824         {
 825                 snprintf(line, 5, "%04x", i);
 826                 for (j = i; j < i + BYTES_PER_LINE && j < length; j++)
 827                 {
 828                         snprintf(s, 4, " %02x", buffer[j]);
 829                         strcat(line, s);
 830                 }
 831                 LOG_DEBUG("%s", line);
 832         }
 833 }
 834 #endif
 835