git.gag.com Git - fw/openocd/blob - src/jtag/arm-jtag-ew.c

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