src/jtag/drivers/opendous.c

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2009 by Cahya Wirawan <cahya@gmx.at>                    *
   4  *   Based on opendous driver by Vladimir Fonov                            *
   5  *                                                                         *
   6  *   Copyright (C) 2009 by Vladimir Fonov <vladimir.fonov@gmai.com>        *
   7  *   Based on J-link driver by  Juergen Stuber                             *
   8  *                                                                         *
   9  *   Copyright (C) 2007 by Juergen Stuber <juergen@jstuber.net>            *
  10  *   based on Dominic Rath's and Benedikt Sauter's usbprog.c               *
  11  *                                                                         *
  12  *   Copyright (C) 2008 by Spencer Oliver                                  *
  13  *   spen@spen-soft.co.uk                                                  *
  14  *                                                                         *
  15  *   This program is free software; you can redistribute it and/or modify  *
  16  *   it under the terms of the GNU General Public License as published by  *
  17  *   the Free Software Foundation; either version 2 of the License, or     *
  18  *   (at your option) any later version.                                   *
  19  *                                                                         *
  20  *   This program is distributed in the hope that it will be useful,       *
  21  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  22  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  23  *   GNU General Public License for more details.                          *
  24  *                                                                         *
  25  *   You should have received a copy of the GNU General Public License     *
  26  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  27  ***************************************************************************/
  28
  29 #ifdef HAVE_CONFIG_H
  30 #include "config.h"
  31 #endif
  32
  33 #include <jtag/interface.h>
  34 #include <jtag/commands.h>
  35 #include "libusb_common.h"
  36 #include <string.h>
  37 #include <time.h>
  38
  39 #define OPENDOUS_MAX_VIDS_PIDS 4
  40 /* define some probes with similar interface */
  41 struct opendous_probe {
  42         const char *name;
  43         uint16_t VID[OPENDOUS_MAX_VIDS_PIDS];
  44         uint16_t PID[OPENDOUS_MAX_VIDS_PIDS];
  45         uint8_t READ_EP;
  46         uint8_t WRITE_EP;
  47         uint8_t CONTROL_TRANSFER;
  48         int BUFFERSIZE;
  49 };
  50
  51 static const struct opendous_probe opendous_probes[] = {
  52         {"usbprog-jtag",        {0x1781, 0},                    {0x0C63, 0},                    0x82, 0x02, 0x00, 510 },
  53         {"opendous",            {0x1781, 0x03EB, 0},    {0xC0C0, 0x204F, 0},    0x81, 0x02, 0x00, 360 },
  54         {"usbvlab",                     {0x16C0, 0},                    {0x05DC, 0},                    0x81, 0x02, 0x01, 360 },
  55         {NULL,                          {0x0000},                               {0x0000},                               0x00, 0x00, 0x00,   0 }
  56 };
  57
  58 #define OPENDOUS_WRITE_ENDPOINT   (opendous_probe->WRITE_EP)
  59 #define OPENDOUS_READ_ENDPOINT    (opendous_probe->READ_EP)
  60
  61 static unsigned int opendous_hw_jtag_version = 1;
  62
  63 #define OPENDOUS_USB_TIMEOUT      1000
  64
  65 #define OPENDOUS_USB_BUFFER_SIZE  (opendous_probe->BUFFERSIZE)
  66 #define OPENDOUS_IN_BUFFER_SIZE   (OPENDOUS_USB_BUFFER_SIZE)
  67 #define OPENDOUS_OUT_BUFFER_SIZE  (OPENDOUS_USB_BUFFER_SIZE)
  68
  69 /* Global USB buffers */
  70 static uint8_t *usb_in_buffer;
  71 static uint8_t *usb_out_buffer;
  72
  73 /* Constants for OPENDOUS command */
  74
  75 #define OPENDOUS_MAX_SPEED                      66
  76 #define OPENDOUS_MAX_TAP_TRANSMIT       ((opendous_probe->BUFFERSIZE)-10)
  77 #define OPENDOUS_MAX_INPUT_DATA         (OPENDOUS_MAX_TAP_TRANSMIT*4)
  78
  79 /* TAP */
  80 #define OPENDOUS_TAP_BUFFER_SIZE 65536
  81
  82 struct pending_scan_result {
  83         int first;      /* First bit position in tdo_buffer to read */
  84         int length; /* Number of bits to read */
  85         struct scan_command *command; /* Corresponding scan command */
  86         uint8_t *buffer;
  87 };
  88
  89 static int pending_scan_results_length;
  90 static struct pending_scan_result *pending_scan_results_buffer;
  91
  92 #define MAX_PENDING_SCAN_RESULTS (OPENDOUS_MAX_INPUT_DATA)
  93
  94 /* JTAG usb commands */
  95 #define JTAG_CMD_TAP_OUTPUT             0x0
  96 #define JTAG_CMD_SET_TRST               0x1
  97 #define JTAG_CMD_SET_SRST               0x2
  98 #define JTAG_CMD_READ_INPUT             0x3
  99 #define JTAG_CMD_TAP_OUTPUT_EMU 0x4
 100 #define JTAG_CMD_SET_DELAY              0x5
 101 #define JTAG_CMD_SET_SRST_TRST  0x6
 102 #define JTAG_CMD_READ_CONFIG    0x7
 103
 104 /* usbvlab control transfer */
 105 #define FUNC_START_BOOTLOADER 30
 106 #define FUNC_WRITE_DATA       0x50
 107 #define FUNC_READ_DATA        0x51
 108
 109 static char *opendous_type;
 110 static const struct opendous_probe *opendous_probe;
 111
 112 /* External interface functions */
 113 static int opendous_execute_queue(void);
 114 static int opendous_init(void);
 115 static int opendous_quit(void);
 116
 117 /* Queue command functions */
 118 static void opendous_end_state(tap_state_t state);
 119 static void opendous_state_move(void);
 120 static void opendous_path_move(int num_states, tap_state_t *path);
 121 static void opendous_runtest(int num_cycles);
 122 static void opendous_scan(int ir_scan, enum scan_type type, uint8_t *buffer,
 123                 int scan_size, struct scan_command *command);
 124 static void opendous_reset(int trst, int srst);
 125 static void opendous_simple_command(uint8_t command, uint8_t _data);
 126 static int opendous_get_status(void);
 127
 128 /* opendous tap buffer functions */
 129 static void opendous_tap_init(void);
 130 static int opendous_tap_execute(void);
 131 static void opendous_tap_ensure_space(int scans, int bits);
 132 static void opendous_tap_append_step(int tms, int tdi);
 133 static void opendous_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command);
 134
 135 /* opendous lowlevel functions */
 136 struct opendous_jtag {
 137         struct jtag_libusb_device_handle *usb_handle;
 138 };
 139
 140 static struct opendous_jtag *opendous_usb_open(void);
 141 static void opendous_usb_close(struct opendous_jtag *opendous_jtag);
 142 static int opendous_usb_message(struct opendous_jtag *opendous_jtag, int out_length, int in_length);
 143 static int opendous_usb_write(struct opendous_jtag *opendous_jtag, int out_length);
 144 static int opendous_usb_read(struct opendous_jtag *opendous_jtag);
 145
 146 /* helper functions */
 147 int opendous_get_version_info(void);
 148
 149 #ifdef _DEBUG_USB_COMMS_
 150 static void opendous_debug_buffer(uint8_t *buffer, int length);
 151 #endif
 152
 153 static struct opendous_jtag *opendous_jtag_handle;
 154
 155 /***************************************************************************/
 156 /* External interface implementation */
 157
 158 COMMAND_HANDLER(opendous_handle_opendous_type_command)
 159 {
 160         if (CMD_ARGC == 0)
 161                 return ERROR_OK;
 162
 163         /* only if the cable name wasn't overwritten by cmdline */
 164         if (opendous_type == NULL) {
 165                 /* REVISIT first verify that it's listed in cables[] ... */
 166                 opendous_type = strdup(CMD_ARGV[0]);
 167         }
 168
 169         /* REVISIT it's probably worth returning the current value ... */
 170
 171         return ERROR_OK;
 172 }
 173
 174 COMMAND_HANDLER(opendous_handle_opendous_info_command)
 175 {
 176         if (opendous_get_version_info() == ERROR_OK) {
 177                 /* attempt to get status */
 178                 opendous_get_status();
 179         }
 180
 181         return ERROR_OK;
 182 }
 183
 184 COMMAND_HANDLER(opendous_handle_opendous_hw_jtag_command)
 185 {
 186         switch (CMD_ARGC) {
 187                 case 0:
 188                         command_print(CMD, "opendous hw jtag  %i", opendous_hw_jtag_version);
 189                         break;
 190
 191                 case 1: {
 192                         int request_version = atoi(CMD_ARGV[0]);
 193                         switch (request_version) {
 194                                 case 2:
 195                                 case 3:
 196                                         opendous_hw_jtag_version = request_version;
 197                                         break;
 198
 199                         default:
 200                                 return ERROR_COMMAND_SYNTAX_ERROR;
 201                         }
 202                         break;
 203                 }
 204
 205                 default:
 206                         return ERROR_COMMAND_SYNTAX_ERROR;
 207         }
 208
 209         return ERROR_OK;
 210 }
 211
 212 static const struct command_registration opendous_command_handlers[] = {
 213         {
 214                 .name = "opendous_info",
 215                 .handler = &opendous_handle_opendous_info_command,
 216                 .mode = COMMAND_EXEC,
 217                 .help = "show opendous info",
 218                 .usage = "",
 219         },
 220         {
 221                 .name = "opendous_hw_jtag",
 222                 .handler = &opendous_handle_opendous_hw_jtag_command,
 223                 .mode = COMMAND_EXEC,
 224                 .help = "access opendous HW JTAG command version",
 225                 .usage = "[2|3]",
 226         },
 227         {
 228                 .name = "opendous_type",
 229                 .handler = &opendous_handle_opendous_type_command,
 230                 .mode = COMMAND_CONFIG,
 231                 .help = "set opendous type",
 232                 .usage = "[usbvlab|usbprog-jtag|opendous]",
 233         },
 234         COMMAND_REGISTRATION_DONE
 235 };
 236
 237 static struct jtag_interface opendous_interface = {
 238         .execute_queue = opendous_execute_queue,
 239 };
 240
 241 struct adapter_driver opendous_adapter_driver = {
 242         .name = "opendous",
 243         .transports = jtag_only,
 244         .commands = opendous_command_handlers,
 245
 246         .init = opendous_init,
 247         .quit = opendous_quit,
 248
 249         .jtag_ops = &opendous_interface,
 250 };
 251
 252 static int opendous_execute_queue(void)
 253 {
 254         struct jtag_command *cmd = jtag_command_queue;
 255         int scan_size;
 256         enum scan_type type;
 257         uint8_t *buffer;
 258
 259         while (cmd != NULL) {
 260                 switch (cmd->type) {
 261                         case JTAG_RUNTEST:
 262                                 LOG_DEBUG_IO("runtest %i cycles, end in %i", cmd->cmd.runtest->num_cycles, \
 263                                         cmd->cmd.runtest->end_state);
 264
 265                                 if (cmd->cmd.runtest->end_state != -1)
 266                                         opendous_end_state(cmd->cmd.runtest->end_state);
 267                                 opendous_runtest(cmd->cmd.runtest->num_cycles);
 268                                 break;
 269
 270                         case JTAG_TLR_RESET:
 271                                 LOG_DEBUG_IO("statemove end in %i", cmd->cmd.statemove->end_state);
 272
 273                                 if (cmd->cmd.statemove->end_state != -1)
 274                                         opendous_end_state(cmd->cmd.statemove->end_state);
 275                                 opendous_state_move();
 276                                 break;
 277
 278                         case JTAG_PATHMOVE:
 279                                 LOG_DEBUG_IO("pathmove: %i states, end in %i", \
 280                                         cmd->cmd.pathmove->num_states, \
 281                                         cmd->cmd.pathmove->path[cmd->cmd.pathmove->num_states - 1]);
 282
 283                                 opendous_path_move(cmd->cmd.pathmove->num_states, cmd->cmd.pathmove->path);
 284                                 break;
 285
 286                         case JTAG_SCAN:
 287                                 LOG_DEBUG_IO("scan end in %i", cmd->cmd.scan->end_state);
 288
 289                                 if (cmd->cmd.scan->end_state != -1)
 290                                         opendous_end_state(cmd->cmd.scan->end_state);
 291
 292                                 scan_size = jtag_build_buffer(cmd->cmd.scan, &buffer);
 293                                 LOG_DEBUG_IO("scan input, length = %d", scan_size);
 294
 295 #ifdef _DEBUG_USB_COMMS_
 296                                 opendous_debug_buffer(buffer, (scan_size + 7) / 8);
 297 #endif
 298                                 type = jtag_scan_type(cmd->cmd.scan);
 299                                 opendous_scan(cmd->cmd.scan->ir_scan, type, buffer, scan_size, cmd->cmd.scan);
 300                                 break;
 301
 302                         case JTAG_RESET:
 303                                 LOG_DEBUG_IO("reset trst: %i srst %i", cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 304
 305                                 opendous_tap_execute();
 306
 307                                 if (cmd->cmd.reset->trst == 1)
 308                                         tap_set_state(TAP_RESET);
 309                                 opendous_reset(cmd->cmd.reset->trst, cmd->cmd.reset->srst);
 310                                 break;
 311
 312                         case JTAG_SLEEP:
 313                                 LOG_DEBUG_IO("sleep %" PRIi32, cmd->cmd.sleep->us);
 314                                 opendous_tap_execute();
 315                                 jtag_sleep(cmd->cmd.sleep->us);
 316                                 break;
 317
 318                         default:
 319                                 LOG_ERROR("BUG: unknown JTAG command type encountered");
 320                                 exit(-1);
 321                 }
 322                 cmd = cmd->next;
 323         }
 324         return opendous_tap_execute();
 325 }
 326
 327 static int opendous_init(void)
 328 {
 329         int check_cnt;
 330         const struct opendous_probe *cur_opendous_probe;
 331
 332         cur_opendous_probe = opendous_probes;
 333
 334         if (opendous_type == NULL) {
 335                 opendous_type = strdup("opendous");
 336                 LOG_WARNING("No opendous_type specified, using default 'opendous'");
 337         }
 338
 339         while (cur_opendous_probe->name) {
 340                 if (strcmp(cur_opendous_probe->name, opendous_type) == 0) {
 341                         opendous_probe = cur_opendous_probe;
 342                         break;
 343                 }
 344                 cur_opendous_probe++;
 345         }
 346
 347         if (!opendous_probe) {
 348                 LOG_ERROR("No matching cable found for %s", opendous_type);
 349                 return ERROR_JTAG_INIT_FAILED;
 350         }
 351
 352
 353         usb_in_buffer = malloc(opendous_probe->BUFFERSIZE);
 354         usb_out_buffer = malloc(opendous_probe->BUFFERSIZE);
 355
 356         pending_scan_results_buffer = malloc(
 357                         MAX_PENDING_SCAN_RESULTS * sizeof(*pending_scan_results_buffer));
 358
 359         opendous_jtag_handle = opendous_usb_open();
 360
 361         if (opendous_jtag_handle == 0) {
 362                 LOG_ERROR("Cannot find opendous Interface! Please check connection and permissions.");
 363                 return ERROR_JTAG_INIT_FAILED;
 364         }
 365
 366         check_cnt = 0;
 367         while (check_cnt < 3) {
 368                 if (opendous_get_version_info() == ERROR_OK) {
 369                         /* attempt to get status */
 370                         opendous_get_status();
 371                         break;
 372                 }
 373
 374                 check_cnt++;
 375         }
 376
 377         LOG_INFO("opendous JTAG Interface ready");
 378
 379         opendous_reset(0, 0);
 380         opendous_tap_init();
 381
 382         return ERROR_OK;
 383 }
 384
 385 static int opendous_quit(void)
 386 {
 387         opendous_usb_close(opendous_jtag_handle);
 388
 389         if (usb_out_buffer) {
 390                 free(usb_out_buffer);
 391                 usb_out_buffer = NULL;
 392         }
 393
 394         if (usb_in_buffer) {
 395                 free(usb_in_buffer);
 396                 usb_in_buffer = NULL;
 397         }
 398
 399         if (pending_scan_results_buffer) {
 400                 free(pending_scan_results_buffer);
 401                 pending_scan_results_buffer = NULL;
 402         }
 403
 404         if (opendous_type) {
 405                 free(opendous_type);
 406                 opendous_type = NULL;
 407         }
 408
 409         return ERROR_OK;
 410 }
 411
 412 /***************************************************************************/
 413 /* Queue command implementations */
 414
 415 void opendous_end_state(tap_state_t state)
 416 {
 417         if (tap_is_state_stable(state))
 418                 tap_set_end_state(state);
 419         else {
 420                 LOG_ERROR("BUG: %i is not a valid end state", state);
 421                 exit(-1);
 422         }
 423 }
 424
 425 /* Goes to the end state. */
 426 void opendous_state_move(void)
 427 {
 428         int i;
 429         int tms = 0;
 430         uint8_t tms_scan = tap_get_tms_path(tap_get_state(), tap_get_end_state());
 431         uint8_t tms_scan_bits = tap_get_tms_path_len(tap_get_state(), tap_get_end_state());
 432
 433         for (i = 0; i < tms_scan_bits; i++) {
 434                 tms = (tms_scan >> i) & 1;
 435                 opendous_tap_append_step(tms, 0);
 436         }
 437
 438         tap_set_state(tap_get_end_state());
 439 }
 440
 441 void opendous_path_move(int num_states, tap_state_t *path)
 442 {
 443         int i;
 444
 445         for (i = 0; i < num_states; i++) {
 446                 if (path[i] == tap_state_transition(tap_get_state(), false))
 447                         opendous_tap_append_step(0, 0);
 448                 else if (path[i] == tap_state_transition(tap_get_state(), true))
 449                         opendous_tap_append_step(1, 0);
 450                 else {
 451                         LOG_ERROR("BUG: %s -> %s isn't a valid TAP transition",
 452                                         tap_state_name(tap_get_state()), tap_state_name(path[i]));
 453                         exit(-1);
 454                 }
 455
 456                 tap_set_state(path[i]);
 457         }
 458
 459         tap_set_end_state(tap_get_state());
 460 }
 461
 462 void opendous_runtest(int num_cycles)
 463 {
 464         int i;
 465
 466         tap_state_t saved_end_state = tap_get_end_state();
 467
 468         /* only do a state_move when we're not already in IDLE */
 469         if (tap_get_state() != TAP_IDLE) {
 470                 opendous_end_state(TAP_IDLE);
 471                 opendous_state_move();
 472         }
 473
 474         /* execute num_cycles */
 475         for (i = 0; i < num_cycles; i++)
 476                 opendous_tap_append_step(0, 0);
 477
 478         /* finish in end_state */
 479         opendous_end_state(saved_end_state);
 480         if (tap_get_state() != tap_get_end_state())
 481                 opendous_state_move();
 482 }
 483
 484 void opendous_scan(int ir_scan, enum scan_type type, uint8_t *buffer, int scan_size, struct scan_command *command)
 485 {
 486         tap_state_t saved_end_state;
 487
 488         opendous_tap_ensure_space(1, scan_size + 8);
 489
 490         saved_end_state = tap_get_end_state();
 491
 492         /* Move to appropriate scan state */
 493         opendous_end_state(ir_scan ? TAP_IRSHIFT : TAP_DRSHIFT);
 494
 495         if (tap_get_state() != tap_get_end_state())
 496                 opendous_state_move();
 497
 498         opendous_end_state(saved_end_state);
 499
 500         /* Scan */
 501         opendous_tap_append_scan(scan_size, buffer, command);
 502
 503         /* We are in Exit1, go to Pause */
 504         opendous_tap_append_step(0, 0);
 505
 506         tap_set_state(ir_scan ? TAP_IRPAUSE : TAP_DRPAUSE);
 507
 508         if (tap_get_state() != tap_get_end_state())
 509                 opendous_state_move();
 510 }
 511
 512 void opendous_reset(int trst, int srst)
 513 {
 514         LOG_DEBUG("trst: %i, srst: %i", trst, srst);
 515
 516         /* Signals are active low */
 517 #if 0
 518         if (srst == 0)
 519                 opendous_simple_command(JTAG_CMD_SET_SRST, 1);
 520         else if (srst == 1)
 521                 opendous_simple_command(JTAG_CMD_SET_SRST, 0);
 522
 523         if (trst == 0)
 524                 opendous_simple_command(JTAG_CMD_SET_TRST, 1);
 525         else if (trst == 1)
 526                 opendous_simple_command(JTAG_CMD_SET_TRST, 0);
 527 #endif
 528
 529         srst = srst ? 0 : 1;
 530         trst = trst ? 0 : 2;
 531         opendous_simple_command(JTAG_CMD_SET_SRST_TRST, srst | trst);
 532 }
 533
 534 void opendous_simple_command(uint8_t command, uint8_t _data)
 535 {
 536         int result;
 537
 538         LOG_DEBUG_IO("0x%02x 0x%02x", command, _data);
 539
 540         usb_out_buffer[0] = 2;
 541         usb_out_buffer[1] = 0;
 542         usb_out_buffer[2] = command;
 543         usb_out_buffer[3] = _data;
 544
 545         result = opendous_usb_message(opendous_jtag_handle, 4, 1);
 546         if (result != 1)
 547                 LOG_ERROR("opendous command 0x%02x failed (%d)", command, result);
 548 }
 549
 550 int opendous_get_status(void)
 551 {
 552         return ERROR_OK;
 553 }
 554
 555 int opendous_get_version_info(void)
 556 {
 557         return ERROR_OK;
 558 }
 559
 560 /***************************************************************************/
 561 /* Estick tap functions */
 562
 563 static int tap_length;
 564 static uint8_t tms_buffer[OPENDOUS_TAP_BUFFER_SIZE];
 565 static uint8_t tdo_buffer[OPENDOUS_TAP_BUFFER_SIZE];
 566
 567 static int last_tms;
 568
 569 void opendous_tap_init(void)
 570 {
 571         tap_length = 0;
 572         pending_scan_results_length = 0;
 573 }
 574
 575 void opendous_tap_ensure_space(int scans, int bits)
 576 {
 577         int available_scans = MAX_PENDING_SCAN_RESULTS - pending_scan_results_length;
 578         int available_bits = OPENDOUS_TAP_BUFFER_SIZE / 2 - tap_length;
 579
 580         if ((scans > available_scans) || (bits > available_bits))
 581                 opendous_tap_execute();
 582 }
 583
 584 void opendous_tap_append_step(int tms, int tdi)
 585 {
 586         last_tms = tms;
 587         unsigned char _tms = tms ? 1 : 0;
 588         unsigned char _tdi = tdi ? 1 : 0;
 589
 590         opendous_tap_ensure_space(0, 1);
 591
 592         int tap_index =  tap_length / 4;
 593         int bits  = (tap_length % 4) * 2;
 594
 595         if (tap_length < OPENDOUS_TAP_BUFFER_SIZE) {
 596                 if (!bits)
 597                         tms_buffer[tap_index] = 0;
 598
 599                 tms_buffer[tap_index] |= (_tdi << bits)|(_tms << (bits + 1)) ;
 600                 tap_length++;
 601         } else
 602                 LOG_ERROR("opendous_tap_append_step, overflow");
 603 }
 604
 605 void opendous_tap_append_scan(int length, uint8_t *buffer, struct scan_command *command)
 606 {
 607         LOG_DEBUG_IO("append scan, length = %d", length);
 608
 609         struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[pending_scan_results_length];
 610         int i;
 611
 612         pending_scan_result->first = tap_length;
 613         pending_scan_result->length = length;
 614         pending_scan_result->command = command;
 615         pending_scan_result->buffer = buffer;
 616
 617         for (i = 0; i < length; i++)
 618                 opendous_tap_append_step((i < length-1 ? 0 : 1), (buffer[i / 8] >> (i % 8)) & 1);
 619         pending_scan_results_length++;
 620 }
 621
 622 /* Pad and send a tap sequence to the device, and receive the answer.
 623  * For the purpose of padding we assume that we are in idle or pause state. */
 624 int opendous_tap_execute(void)
 625 {
 626         int byte_length;
 627         int i, j;
 628         int result;
 629
 630 #ifdef _DEBUG_USB_COMMS_
 631         int byte_length_out;
 632 #endif
 633
 634         if (tap_length > 0) {
 635
 636                 /* memset(tdo_buffer,0,OPENDOUS_TAP_BUFFER_SIZE); */
 637                 /* LOG_INFO("OPENDOUS tap execute %d",tap_length); */
 638                 byte_length = (tap_length + 3) / 4;
 639
 640 #ifdef _DEBUG_USB_COMMS_
 641                 byte_length_out = (tap_length + 7) / 8;
 642                 LOG_DEBUG("opendous is sending %d bytes", byte_length);
 643 #endif
 644
 645                 for (j = 0, i = 0; j <  byte_length;) {
 646
 647                         int receive;
 648                         int transmit = byte_length - j;
 649                         if (transmit > OPENDOUS_MAX_TAP_TRANSMIT) {
 650                                 transmit = OPENDOUS_MAX_TAP_TRANSMIT;
 651                                 receive = (OPENDOUS_MAX_TAP_TRANSMIT) / 2;
 652                                 usb_out_buffer[2] = JTAG_CMD_TAP_OUTPUT;
 653                         } else {
 654                                 usb_out_buffer[2] = JTAG_CMD_TAP_OUTPUT | ((tap_length % 4) << 4);
 655                                 receive = (transmit + 1) / 2;
 656                         }
 657                         usb_out_buffer[0] = (transmit + 1) & 0xff;
 658                         usb_out_buffer[1] = ((transmit + 1) >> 8) & 0xff;
 659
 660                         memmove(usb_out_buffer + 3, tms_buffer + j, transmit);
 661                         result = opendous_usb_message(opendous_jtag_handle, 3 + transmit, receive);
 662                         if (result != receive) {
 663                                 LOG_ERROR("opendous_tap_execute, wrong result %d, expected %d", result, receive);
 664                                 return ERROR_JTAG_QUEUE_FAILED;
 665                         }
 666
 667                         memmove(tdo_buffer + i, usb_in_buffer, receive);
 668                         i += receive;
 669                         j += transmit;
 670                 }
 671
 672 #ifdef _DEBUG_USB_COMMS_
 673                 LOG_DEBUG("opendous tap result %d", byte_length_out);
 674                 opendous_debug_buffer(tdo_buffer, byte_length_out);
 675 #endif
 676
 677                 /* LOG_INFO("eStick tap execute %d",tap_length); */
 678                 for (i = 0; i < pending_scan_results_length; i++) {
 679
 680                         struct pending_scan_result *pending_scan_result = &pending_scan_results_buffer[i];
 681                         uint8_t *buffer = pending_scan_result->buffer;
 682                         int length = pending_scan_result->length;
 683                         int first = pending_scan_result->first;
 684                         struct scan_command *command = pending_scan_result->command;
 685
 686                         /* Copy to buffer */
 687                         buf_set_buf(tdo_buffer, first, buffer, 0, length);
 688
 689                         LOG_DEBUG_IO("pending scan result, length = %d", length);
 690
 691 #ifdef _DEBUG_USB_COMMS_
 692                         opendous_debug_buffer(buffer, byte_length_out);
 693 #endif
 694
 695                         if (jtag_read_buffer(buffer, command) != ERROR_OK) {
 696                                 opendous_tap_init();
 697                                 return ERROR_JTAG_QUEUE_FAILED;
 698                         }
 699
 700                         if (pending_scan_result->buffer != NULL)
 701                                 free(pending_scan_result->buffer);
 702                 }
 703
 704                 opendous_tap_init();
 705         }
 706
 707         return ERROR_OK;
 708 }
 709
 710 /*****************************************************************************/
 711 /* Estick USB low-level functions */
 712
 713 struct opendous_jtag *opendous_usb_open(void)
 714 {
 715         struct opendous_jtag *result;
 716
 717         struct jtag_libusb_device_handle *devh;
 718         if (jtag_libusb_open(opendous_probe->VID, opendous_probe->PID, NULL, &devh) != ERROR_OK)
 719                 return NULL;
 720
 721         jtag_libusb_set_configuration(devh, 0);
 722         jtag_libusb_claim_interface(devh, 0);
 723
 724         result = malloc(sizeof(*result));
 725         result->usb_handle = devh;
 726         return result;
 727 }
 728
 729 void opendous_usb_close(struct opendous_jtag *opendous_jtag)
 730 {
 731         jtag_libusb_close(opendous_jtag->usb_handle);
 732         free(opendous_jtag);
 733 }
 734
 735 /* Send a message and receive the reply. */
 736 int opendous_usb_message(struct opendous_jtag *opendous_jtag, int out_length, int in_length)
 737 {
 738         int result;
 739
 740         result = opendous_usb_write(opendous_jtag, out_length);
 741         if (result == out_length) {
 742                 result = opendous_usb_read(opendous_jtag);
 743                 if (result == in_length)
 744                         return result;
 745                 else {
 746                         LOG_ERROR("usb_bulk_read failed (requested=%d, result=%d)", in_length, result);
 747                         return -1;
 748                 }
 749         } else {
 750                 LOG_ERROR("usb_bulk_write failed (requested=%d, result=%d)", out_length, result);
 751                 return -1;
 752         }
 753 }
 754
 755 /* Write data from out_buffer to USB. */
 756 int opendous_usb_write(struct opendous_jtag *opendous_jtag, int out_length)
 757 {
 758         int result;
 759
 760         if (out_length > OPENDOUS_OUT_BUFFER_SIZE) {
 761                 LOG_ERROR("opendous_jtag_write illegal out_length=%d (max=%d)", out_length, OPENDOUS_OUT_BUFFER_SIZE);
 762                 return -1;
 763         }
 764
 765 #ifdef _DEBUG_USB_COMMS_
 766         LOG_DEBUG("USB write begin");
 767 #endif
 768         if (opendous_probe->CONTROL_TRANSFER) {
 769                 result = jtag_libusb_control_transfer(opendous_jtag->usb_handle,
 770                         LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_OUT,
 771                         FUNC_WRITE_DATA, 0, 0, (char *) usb_out_buffer, out_length, OPENDOUS_USB_TIMEOUT);
 772         } else {
 773                 result = jtag_libusb_bulk_write(opendous_jtag->usb_handle, OPENDOUS_WRITE_ENDPOINT, \
 774                         (char *)usb_out_buffer, out_length, OPENDOUS_USB_TIMEOUT);
 775         }
 776 #ifdef _DEBUG_USB_COMMS_
 777         LOG_DEBUG("USB write end: %d bytes", result);
 778 #endif
 779
 780         LOG_DEBUG_IO("opendous_usb_write, out_length = %d, result = %d", out_length, result);
 781
 782 #ifdef _DEBUG_USB_COMMS_
 783         opendous_debug_buffer(usb_out_buffer, out_length);
 784 #endif
 785         return result;
 786 }
 787
 788 /* Read data from USB into in_buffer. */
 789 int opendous_usb_read(struct opendous_jtag *opendous_jtag)
 790 {
 791 #ifdef _DEBUG_USB_COMMS_
 792         LOG_DEBUG("USB read begin");
 793 #endif
 794         int result;
 795         if (opendous_probe->CONTROL_TRANSFER) {
 796                 result = jtag_libusb_control_transfer(opendous_jtag->usb_handle,
 797                         LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_DEVICE | LIBUSB_ENDPOINT_IN,
 798                         FUNC_READ_DATA, 0, 0, (char *) usb_in_buffer, OPENDOUS_IN_BUFFER_SIZE, OPENDOUS_USB_TIMEOUT);
 799         } else {
 800                 result = jtag_libusb_bulk_read(opendous_jtag->usb_handle, OPENDOUS_READ_ENDPOINT,
 801                         (char *)usb_in_buffer, OPENDOUS_IN_BUFFER_SIZE, OPENDOUS_USB_TIMEOUT);
 802         }
 803 #ifdef _DEBUG_USB_COMMS_
 804         LOG_DEBUG("USB read end: %d bytes", result);
 805 #endif
 806         LOG_DEBUG_IO("opendous_usb_read, result = %d", result);
 807
 808 #ifdef _DEBUG_USB_COMMS_
 809         opendous_debug_buffer(usb_in_buffer, result);
 810 #endif
 811         return result;
 812 }
 813
 814 #ifdef _DEBUG_USB_COMMS_
 815 #define BYTES_PER_LINE  16
 816
 817 void opendous_debug_buffer(uint8_t *buffer, int length)
 818 {
 819         char line[81];
 820         char s[4];
 821         int i;
 822         int j;
 823
 824         for (i = 0; i < length; i += BYTES_PER_LINE) {
 825                 snprintf(line, 5, "%04x", i);
 826                 for (j = i; j < i + BYTES_PER_LINE && j < length; j++) {
 827                         snprintf(s, 4, " %02x", buffer[j]);
 828                         strcat(line, s);
 829                 }
 830                 LOG_DEBUG("%s", line);
 831         }
 832 }
 833 #endif