src/hardware/dslogic/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   5  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   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 3 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, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22 #include <math.h>
  23 #include <glib.h>
  24 #include <glib/gstdio.h>
  25 #include "protocol.h"
  26
  27 #define DS_CMD_GET_FW_VERSION           0xb0
  28 #define DS_CMD_GET_REVID_VERSION        0xb1
  29 #define DS_CMD_START                    0xb2
  30 #define DS_CMD_CONFIG                   0xb3
  31 #define DS_CMD_SETTING                  0xb4
  32 #define DS_CMD_CONTROL                  0xb5
  33 #define DS_CMD_STATUS                   0xb6
  34 #define DS_CMD_STATUS_INFO              0xb7
  35 #define DS_CMD_WR_REG                   0xb8
  36 #define DS_CMD_WR_NVM                   0xb9
  37 #define DS_CMD_RD_NVM                   0xba
  38 #define DS_CMD_RD_NVM_PRE               0xbb
  39 #define DS_CMD_GET_HW_INFO              0xbc
  40
  41 #define DS_START_FLAGS_STOP             (1 << 7)
  42 #define DS_START_FLAGS_CLK_48MHZ        (1 << 6)
  43 #define DS_START_FLAGS_SAMPLE_WIDE      (1 << 5)
  44 #define DS_START_FLAGS_MODE_LA          (1 << 4)
  45
  46 #define DS_ADDR_COMB                    0x68
  47 #define DS_ADDR_EEWP                    0x70
  48 #define DS_ADDR_VTH                     0x78
  49
  50 #define DS_MAX_LOGIC_DEPTH              SR_MHZ(16)
  51 #define DS_MAX_LOGIC_SAMPLERATE         SR_MHZ(100)
  52 #define DS_MAX_TRIG_PERCENT             90
  53
  54 #define DS_MODE_TRIG_EN                 (1 << 0)
  55 #define DS_MODE_CLK_TYPE                (1 << 1)
  56 #define DS_MODE_CLK_EDGE                (1 << 2)
  57 #define DS_MODE_RLE_MODE                (1 << 3)
  58 #define DS_MODE_DSO_MODE                (1 << 4)
  59 #define DS_MODE_HALF_MODE               (1 << 5)
  60 #define DS_MODE_QUAR_MODE               (1 << 6)
  61 #define DS_MODE_ANALOG_MODE             (1 << 7)
  62 #define DS_MODE_FILTER                  (1 << 8)
  63 #define DS_MODE_INSTANT                 (1 << 9)
  64 #define DS_MODE_STRIG_MODE              (1 << 11)
  65 #define DS_MODE_STREAM_MODE             (1 << 12)
  66 #define DS_MODE_LPB_TEST                (1 << 13)
  67 #define DS_MODE_EXT_TEST                (1 << 14)
  68 #define DS_MODE_INT_TEST                (1 << 15)
  69
  70 #define DSLOGIC_ATOMIC_SAMPLES          (1 << 6)
  71
  72 /*
  73  * The FPGA is configured with TLV tuples. Length is specified as the
  74  * number of 16-bit words.
  75  */
  76 #define _DS_CFG(variable, wordcnt) ((variable << 8) | wordcnt)
  77 #define DS_CFG_START            0xf5a5f5a5
  78 #define DS_CFG_MODE             _DS_CFG(0, 1)
  79 #define DS_CFG_DIVIDER          _DS_CFG(1, 2)
  80 #define DS_CFG_COUNT            _DS_CFG(3, 2)
  81 #define DS_CFG_TRIG_POS         _DS_CFG(5, 2)
  82 #define DS_CFG_TRIG_GLB         _DS_CFG(7, 1)
  83 #define DS_CFG_CH_EN            _DS_CFG(8, 1)
  84 #define DS_CFG_TRIG             _DS_CFG(64, 160)
  85 #define DS_CFG_END              0xfa5afa5a
  86
  87 #pragma pack(push, 1)
  88
  89 struct version_info {
  90         uint8_t major;
  91         uint8_t minor;
  92 };
  93
  94 struct cmd_start_acquisition {
  95         uint8_t flags;
  96         uint8_t sample_delay_h;
  97         uint8_t sample_delay_l;
  98 };
  99
 100 struct dslogic_fpga_config {
 101         uint32_t sync;
 102
 103         uint16_t mode_header;
 104         uint16_t mode;
 105         uint16_t divider_header;
 106         uint32_t divider;
 107         uint16_t count_header;
 108         uint32_t count;
 109         uint16_t trig_pos_header;
 110         uint32_t trig_pos;
 111         uint16_t trig_glb_header;
 112         uint16_t trig_glb;
 113         uint16_t ch_en_header;
 114         uint16_t ch_en;
 115
 116         uint16_t trig_header;
 117         uint16_t trig_mask0[NUM_TRIGGER_STAGES];
 118         uint16_t trig_mask1[NUM_TRIGGER_STAGES];
 119         uint16_t trig_value0[NUM_TRIGGER_STAGES];
 120         uint16_t trig_value1[NUM_TRIGGER_STAGES];
 121         uint16_t trig_edge0[NUM_TRIGGER_STAGES];
 122         uint16_t trig_edge1[NUM_TRIGGER_STAGES];
 123         uint16_t trig_logic0[NUM_TRIGGER_STAGES];
 124         uint16_t trig_logic1[NUM_TRIGGER_STAGES];
 125         uint32_t trig_count[NUM_TRIGGER_STAGES];
 126
 127         uint32_t end_sync;
 128 };
 129
 130 #pragma pack(pop)
 131
 132 /*
 133  * This should be larger than the FPGA bitstream image so that it'll get
 134  * uploaded in one big operation. There seem to be issues when uploading
 135  * it in chunks.
 136  */
 137 #define FW_BUFSIZE (1024 * 1024)
 138
 139 #define FPGA_UPLOAD_DELAY (10 * 1000)
 140
 141 #define USB_TIMEOUT (3 * 1000)
 142
 143 static int command_get_fw_version(libusb_device_handle *devhdl,
 144                                   struct version_info *vi)
 145 {
 146         int ret;
 147
 148         ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
 149                 LIBUSB_ENDPOINT_IN, DS_CMD_GET_FW_VERSION, 0x0000, 0x0000,
 150                 (unsigned char *)vi, sizeof(struct version_info), USB_TIMEOUT);
 151
 152         if (ret < 0) {
 153                 sr_err("Unable to get version info: %s.",
 154                        libusb_error_name(ret));
 155                 return SR_ERR;
 156         }
 157
 158         return SR_OK;
 159 }
 160
 161 static int command_get_revid_version(struct sr_dev_inst *sdi, uint8_t *revid)
 162 {
 163         struct sr_usb_dev_inst *usb = sdi->conn;
 164         libusb_device_handle *devhdl = usb->devhdl;
 165         int ret;
 166
 167         ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
 168                 LIBUSB_ENDPOINT_IN, DS_CMD_GET_REVID_VERSION, 0x0000, 0x0000,
 169                 revid, 1, USB_TIMEOUT);
 170
 171         if (ret < 0) {
 172                 sr_err("Unable to get REVID: %s.", libusb_error_name(ret));
 173                 return SR_ERR;
 174         }
 175
 176         return SR_OK;
 177 }
 178
 179 static int command_start_acquisition(const struct sr_dev_inst *sdi)
 180 {
 181         struct sr_usb_dev_inst *usb;
 182         struct dslogic_mode mode;
 183         int ret;
 184
 185         mode.flags = DS_START_FLAGS_MODE_LA | DS_START_FLAGS_SAMPLE_WIDE;
 186         mode.sample_delay_h = mode.sample_delay_l = 0;
 187
 188         usb = sdi->conn;
 189         ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
 190                         LIBUSB_ENDPOINT_OUT, DS_CMD_START, 0x0000, 0x0000,
 191                         (unsigned char *)&mode, sizeof(mode), USB_TIMEOUT);
 192         if (ret < 0) {
 193                 sr_err("Failed to send start command: %s.", libusb_error_name(ret));
 194                 return SR_ERR;
 195         }
 196
 197         return SR_OK;
 198 }
 199
 200 static int command_stop_acquisition(const struct sr_dev_inst *sdi)
 201 {
 202         struct sr_usb_dev_inst *usb;
 203         struct dslogic_mode mode;
 204         int ret;
 205
 206         mode.flags = DS_START_FLAGS_STOP;
 207         mode.sample_delay_h = mode.sample_delay_l = 0;
 208
 209         usb = sdi->conn;
 210         ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
 211                         LIBUSB_ENDPOINT_OUT, DS_CMD_START, 0x0000, 0x0000,
 212                         (unsigned char *)&mode, sizeof(struct dslogic_mode), USB_TIMEOUT);
 213         if (ret < 0) {
 214                 sr_err("Failed to send stop command: %s.", libusb_error_name(ret));
 215                 return SR_ERR;
 216         }
 217
 218         return SR_OK;
 219 }
 220
 221 SR_PRIV int dslogic_fpga_firmware_upload(const struct sr_dev_inst *sdi)
 222 {
 223         const char *name = NULL;
 224         uint64_t sum;
 225         struct sr_resource bitstream;
 226         struct drv_context *drvc;
 227         struct dev_context *devc;
 228         struct sr_usb_dev_inst *usb;
 229         unsigned char *buf;
 230         ssize_t chunksize;
 231         int transferred;
 232         int result, ret;
 233         const uint8_t cmd[3] = {0, 0, 0};
 234
 235         drvc = sdi->driver->context;
 236         devc = sdi->priv;
 237         usb = sdi->conn;
 238
 239         if (!strcmp(devc->profile->model, "DSLogic")) {
 240                 if (devc->cur_threshold < 1.40)
 241                         name = DSLOGIC_FPGA_FIRMWARE_3V3;
 242                 else
 243                         name = DSLOGIC_FPGA_FIRMWARE_5V;
 244         } else if (!strcmp(devc->profile->model, "DSLogic Pro")){
 245                 name = DSLOGIC_PRO_FPGA_FIRMWARE;
 246         } else if (!strcmp(devc->profile->model, "DSLogic Plus")){
 247                 name = DSLOGIC_PLUS_FPGA_FIRMWARE;
 248         } else if (!strcmp(devc->profile->model, "DSLogic Basic")){
 249                 name = DSLOGIC_BASIC_FPGA_FIRMWARE;
 250         } else if (!strcmp(devc->profile->model, "DSCope")) {
 251                 name = DSCOPE_FPGA_FIRMWARE;
 252         } else {
 253                 sr_err("Failed to select FPGA firmware.");
 254                 return SR_ERR;
 255         }
 256
 257         sr_dbg("Uploading FPGA firmware '%s'.", name);
 258
 259         result = sr_resource_open(drvc->sr_ctx, &bitstream,
 260                         SR_RESOURCE_FIRMWARE, name);
 261         if (result != SR_OK)
 262                 return result;
 263
 264         /* Tell the device firmware is coming. */
 265         if ((ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
 266                         LIBUSB_ENDPOINT_OUT, DS_CMD_CONFIG, 0x0000, 0x0000,
 267                         (unsigned char *)&cmd, sizeof(cmd), USB_TIMEOUT)) < 0) {
 268                 sr_err("Failed to upload FPGA firmware: %s.", libusb_error_name(ret));
 269                 sr_resource_close(drvc->sr_ctx, &bitstream);
 270                 return SR_ERR;
 271         }
 272
 273         /* Give the FX2 time to get ready for FPGA firmware upload. */
 274         g_usleep(FPGA_UPLOAD_DELAY);
 275
 276         buf = g_malloc(FW_BUFSIZE);
 277         sum = 0;
 278         result = SR_OK;
 279         while (1) {
 280                 chunksize = sr_resource_read(drvc->sr_ctx, &bitstream,
 281                                 buf, FW_BUFSIZE);
 282                 if (chunksize < 0)
 283                         result = SR_ERR;
 284                 if (chunksize <= 0)
 285                         break;
 286
 287                 if ((ret = libusb_bulk_transfer(usb->devhdl, 2 | LIBUSB_ENDPOINT_OUT,
 288                                 buf, chunksize, &transferred, USB_TIMEOUT)) < 0) {
 289                         sr_err("Unable to configure FPGA firmware: %s.",
 290                                         libusb_error_name(ret));
 291                         result = SR_ERR;
 292                         break;
 293                 }
 294                 sum += transferred;
 295                 sr_spew("Uploaded %" PRIu64 "/%" PRIu64 " bytes.",
 296                         sum, bitstream.size);
 297
 298                 if (transferred != chunksize) {
 299                         sr_err("Short transfer while uploading FPGA firmware.");
 300                         result = SR_ERR;
 301                         break;
 302                 }
 303         }
 304         g_free(buf);
 305         sr_resource_close(drvc->sr_ctx, &bitstream);
 306
 307         if (result == SR_OK)
 308                 sr_dbg("FPGA firmware upload done.");
 309
 310         return result;
 311 }
 312
 313 /*
 314  * Get the session trigger and configure the FPGA structure
 315  * accordingly.
 316  */
 317 static void set_trigger(const struct sr_dev_inst *sdi,
 318         struct dslogic_fpga_config *cfg)
 319 {
 320         struct sr_trigger *trigger;
 321         struct sr_trigger_stage *stage;
 322         struct sr_trigger_match *match;
 323         struct dev_context *devc;
 324         const GSList *l, *m;
 325         int num_enabled_channels = 0, num_trigger_stages = 0;
 326         int channelbit, i = 0;
 327         uint32_t trigger_point;
 328
 329         devc = sdi->priv;
 330
 331         cfg->ch_en = 0;
 332         for (l = sdi->channels; l; l = l->next) {
 333                 const struct sr_channel *const probe = (struct sr_channel *)l->data;
 334                 if (probe->enabled) {
 335                         num_enabled_channels++;
 336                         cfg->ch_en |= 1 << probe->index;
 337                 }
 338         }
 339
 340         cfg->trig_mask0[0] = 0xffff;
 341         cfg->trig_mask1[0] = 0xffff;
 342
 343         cfg->trig_value0[0] = 0;
 344         cfg->trig_value1[0] = 0;
 345
 346         cfg->trig_edge0[0] = 0;
 347         cfg->trig_edge1[0] = 0;
 348
 349         cfg->trig_logic0[0] = 2;
 350         cfg->trig_logic1[0] = 2;
 351
 352         cfg->trig_count[0] = 0;
 353
 354         cfg->trig_glb = num_enabled_channels << 4;
 355
 356         for (i = 1; i < NUM_TRIGGER_STAGES; i++) {
 357                 cfg->trig_mask0[i] = 0xffff;
 358                 cfg->trig_mask1[i] = 0xffff;
 359                 cfg->trig_value0[i] = 0;
 360                 cfg->trig_value1[i] = 0;
 361                 cfg->trig_edge0[i] = 0;
 362                 cfg->trig_edge1[i] = 0;
 363                 cfg->trig_logic0[i] = 2;
 364                 cfg->trig_logic1[i] = 2;
 365                 cfg->trig_count[i] = 0;
 366         }
 367
 368         trigger_point = (devc->capture_ratio * devc->limit_samples) / 100;
 369         if (trigger_point < DSLOGIC_ATOMIC_SAMPLES)
 370                 trigger_point = DSLOGIC_ATOMIC_SAMPLES;
 371         const uint32_t mem_depth = devc->profile->mem_depth;
 372         const uint32_t max_trigger_point = devc->continuous_mode ? ((mem_depth * 10) / 100) :
 373                 ((mem_depth * DS_MAX_TRIG_PERCENT) / 100);
 374         if (trigger_point > max_trigger_point)
 375                 trigger_point = max_trigger_point;
 376         cfg->trig_pos = trigger_point & ~(DSLOGIC_ATOMIC_SAMPLES - 1);
 377
 378         if (!(trigger = sr_session_trigger_get(sdi->session))) {
 379                 sr_dbg("No session trigger found");
 380                 return;
 381         }
 382
 383         for (l = trigger->stages; l; l = l->next) {
 384                 stage = l->data;
 385                 num_trigger_stages++;
 386                 for (m = stage->matches; m; m = m->next) {
 387                         match = m->data;
 388                         if (!match->channel->enabled)
 389                                 /* Ignore disabled channels with a trigger. */
 390                                 continue;
 391                         channelbit = 1 << (match->channel->index);
 392                         /* Simple trigger support (event). */
 393                         if (match->match == SR_TRIGGER_ONE) {
 394                                 cfg->trig_mask0[0] &= ~channelbit;
 395                                 cfg->trig_mask1[0] &= ~channelbit;
 396                                 cfg->trig_value0[0] |= channelbit;
 397                                 cfg->trig_value1[0] |= channelbit;
 398                         } else if (match->match == SR_TRIGGER_ZERO) {
 399                                 cfg->trig_mask0[0] &= ~channelbit;
 400                                 cfg->trig_mask1[0] &= ~channelbit;
 401                         } else if (match->match == SR_TRIGGER_FALLING) {
 402                                 cfg->trig_mask0[0] &= ~channelbit;
 403                                 cfg->trig_mask1[0] &= ~channelbit;
 404                                 cfg->trig_edge0[0] |= channelbit;
 405                                 cfg->trig_edge1[0] |= channelbit;
 406                         } else if (match->match == SR_TRIGGER_RISING) {
 407                                 cfg->trig_mask0[0] &= ~channelbit;
 408                                 cfg->trig_mask1[0] &= ~channelbit;
 409                                 cfg->trig_value0[0] |= channelbit;
 410                                 cfg->trig_value1[0] |= channelbit;
 411                                 cfg->trig_edge0[0] |= channelbit;
 412                                 cfg->trig_edge1[0] |= channelbit;
 413                         } else if (match->match == SR_TRIGGER_EDGE) {
 414                                 cfg->trig_edge0[0] |= channelbit;
 415                                 cfg->trig_edge1[0] |= channelbit;
 416                         }
 417                 }
 418         }
 419
 420         cfg->trig_glb |= num_trigger_stages;
 421
 422         return;
 423 }
 424
 425 static int fpga_configure(const struct sr_dev_inst *sdi)
 426 {
 427         struct dev_context *devc;
 428         struct sr_usb_dev_inst *usb;
 429         uint8_t c[3];
 430         struct dslogic_fpga_config cfg;
 431         uint16_t v16;
 432         uint32_t v32;
 433         int transferred, len, ret;
 434
 435         sr_dbg("Configuring FPGA.");
 436
 437         usb = sdi->conn;
 438         devc = sdi->priv;
 439
 440         WL32(&cfg.sync, DS_CFG_START);
 441         WL16(&cfg.mode_header, DS_CFG_MODE);
 442         WL16(&cfg.divider_header, DS_CFG_DIVIDER);
 443         WL16(&cfg.count_header, DS_CFG_COUNT);
 444         WL16(&cfg.trig_pos_header, DS_CFG_TRIG_POS);
 445         WL16(&cfg.trig_glb_header, DS_CFG_TRIG_GLB);
 446         WL16(&cfg.ch_en_header, DS_CFG_CH_EN);
 447         WL16(&cfg.trig_header, DS_CFG_TRIG);
 448         WL32(&cfg.end_sync, DS_CFG_END);
 449
 450         /* Pass in the length of a fixed-size struct. Really. */
 451         len = sizeof(struct dslogic_fpga_config) / 2;
 452         c[0] = len & 0xff;
 453         c[1] = (len >> 8) & 0xff;
 454         c[2] = (len >> 16) & 0xff;
 455
 456         ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
 457                         LIBUSB_ENDPOINT_OUT, DS_CMD_SETTING, 0x0000, 0x0000,
 458                         c, sizeof(c), USB_TIMEOUT);
 459         if (ret < 0) {
 460                 sr_err("Failed to send FPGA configure command: %s.",
 461                         libusb_error_name(ret));
 462                 return SR_ERR;
 463         }
 464
 465         v16 = 0x0000;
 466
 467         if (devc->mode == DS_OP_INTERNAL_TEST)
 468                 v16 = DS_MODE_INT_TEST;
 469         else if (devc->mode == DS_OP_EXTERNAL_TEST)
 470                 v16 = DS_MODE_EXT_TEST;
 471         else if (devc->mode == DS_OP_LOOPBACK_TEST)
 472                 v16 = DS_MODE_LPB_TEST;
 473
 474         if (devc->cur_samplerate == DS_MAX_LOGIC_SAMPLERATE * 2)
 475                 v16 |= DS_MODE_HALF_MODE;
 476         else if (devc->cur_samplerate == DS_MAX_LOGIC_SAMPLERATE * 4)
 477                 v16 |= DS_MODE_QUAR_MODE;
 478
 479         if (devc->continuous_mode)
 480                 v16 |= DS_MODE_STREAM_MODE;
 481         if (devc->external_clock) {
 482                 v16 |= DS_MODE_CLK_TYPE;
 483                 if (devc->clock_edge == DS_EDGE_FALLING)
 484                         v16 |= DS_MODE_CLK_EDGE;
 485         }
 486         if (devc->limit_samples > DS_MAX_LOGIC_DEPTH *
 487                 ceil(devc->cur_samplerate * 1.0 / DS_MAX_LOGIC_SAMPLERATE)
 488                 && !devc->continuous_mode) {
 489                 /* Enable RLE for long captures.
 490                  * Without this, captured data present errors.
 491                  */
 492                 v16 |= DS_MODE_RLE_MODE;
 493         }
 494
 495         WL16(&cfg.mode, v16);
 496         v32 = ceil(DS_MAX_LOGIC_SAMPLERATE * 1.0 / devc->cur_samplerate);
 497         WL32(&cfg.divider, v32);
 498
 499         /* Number of 16-sample units. */
 500         WL32(&cfg.count, devc->limit_samples / 16);
 501
 502         set_trigger(sdi, &cfg);
 503
 504         len = sizeof(struct dslogic_fpga_config);
 505         ret = libusb_bulk_transfer(usb->devhdl, 2 | LIBUSB_ENDPOINT_OUT,
 506                         (unsigned char *)&cfg, len, &transferred, USB_TIMEOUT);
 507         if (ret < 0 || transferred != len) {
 508                 sr_err("Failed to send FPGA configuration: %s.", libusb_error_name(ret));
 509                 return SR_ERR;
 510         }
 511
 512         return SR_OK;
 513 }
 514
 515 SR_PRIV int dslogic_set_voltage_threshold(const struct sr_dev_inst *sdi, double threshold)
 516 {
 517         int ret;
 518         struct dev_context *const devc = sdi->priv;
 519         const struct sr_usb_dev_inst *const usb = sdi->conn;
 520         const uint8_t value = (threshold / 5.0) * 255;
 521         const uint16_t cmd = value | (DS_ADDR_VTH << 8);
 522
 523         /* Send the control command. */
 524         ret = libusb_control_transfer(usb->devhdl,
 525                         LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT,
 526                         DS_CMD_WR_REG, 0x0000, 0x0000,
 527                         (unsigned char *)&cmd, sizeof(cmd), 3000);
 528         if (ret < 0) {
 529                 sr_err("Unable to set voltage-threshold register: %s.",
 530                 libusb_error_name(ret));
 531                 return SR_ERR;
 532         }
 533
 534         devc->cur_threshold = threshold;
 535
 536         return SR_OK;
 537 }
 538
 539 SR_PRIV int dslogic_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di)
 540 {
 541         libusb_device **devlist;
 542         struct sr_usb_dev_inst *usb;
 543         struct libusb_device_descriptor des;
 544         struct dev_context *devc;
 545         struct drv_context *drvc;
 546         struct version_info vi;
 547         int ret, i, device_count;
 548         uint8_t revid;
 549         char connection_id[64];
 550
 551         drvc = di->context;
 552         devc = sdi->priv;
 553         usb = sdi->conn;
 554
 555         if (sdi->status == SR_ST_ACTIVE)
 556                 /* Device is already in use. */
 557                 return SR_ERR;
 558
 559         device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 560         if (device_count < 0) {
 561                 sr_err("Failed to get device list: %s.",
 562                        libusb_error_name(device_count));
 563                 return SR_ERR;
 564         }
 565
 566         for (i = 0; i < device_count; i++) {
 567                 libusb_get_device_descriptor(devlist[i], &des);
 568
 569                 if (des.idVendor != devc->profile->vid
 570                     || des.idProduct != devc->profile->pid)
 571                         continue;
 572
 573                 if ((sdi->status == SR_ST_INITIALIZING) ||
 574                                 (sdi->status == SR_ST_INACTIVE)) {
 575                         /*
 576                          * Check device by its physical USB bus/port address.
 577                          */
 578                         usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 579                         if (strcmp(sdi->connection_id, connection_id))
 580                                 /* This is not the one. */
 581                                 continue;
 582                 }
 583
 584                 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
 585                         if (usb->address == 0xff)
 586                                 /*
 587                                  * First time we touch this device after FW
 588                                  * upload, so we don't know the address yet.
 589                                  */
 590                                 usb->address = libusb_get_device_address(devlist[i]);
 591                 } else {
 592                         sr_err("Failed to open device: %s.",
 593                                libusb_error_name(ret));
 594                         break;
 595                 }
 596
 597                 if (libusb_has_capability(LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER)) {
 598                         if (libusb_kernel_driver_active(usb->devhdl, USB_INTERFACE) == 1) {
 599                                 if ((ret = libusb_detach_kernel_driver(usb->devhdl, USB_INTERFACE)) < 0) {
 600                                         sr_err("Failed to detach kernel driver: %s.",
 601                                                 libusb_error_name(ret));
 602                                         return SR_ERR;
 603                                 }
 604                         }
 605                 }
 606
 607                 ret = command_get_fw_version(usb->devhdl, &vi);
 608                 if (ret != SR_OK) {
 609                         sr_err("Failed to get firmware version.");
 610                         break;
 611                 }
 612
 613                 ret = command_get_revid_version(sdi, &revid);
 614                 if (ret != SR_OK) {
 615                         sr_err("Failed to get REVID.");
 616                         break;
 617                 }
 618
 619                 /*
 620                  * Changes in major version mean incompatible/API changes, so
 621                  * bail out if we encounter an incompatible version.
 622                  * Different minor versions are OK, they should be compatible.
 623                  */
 624                 if (vi.major != DSLOGIC_REQUIRED_VERSION_MAJOR) {
 625                         sr_err("Expected firmware version %d.x, "
 626                                "got %d.%d.", DSLOGIC_REQUIRED_VERSION_MAJOR,
 627                                vi.major, vi.minor);
 628                         break;
 629                 }
 630
 631                 sdi->status = SR_ST_ACTIVE;
 632                 sr_info("Opened device on %d.%d (logical) / %s (physical), "
 633                         "interface %d, firmware %d.%d.",
 634                         usb->bus, usb->address, connection_id,
 635                         USB_INTERFACE, vi.major, vi.minor);
 636
 637                 sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
 638                         revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
 639
 640                 break;
 641         }
 642         libusb_free_device_list(devlist, 1);
 643
 644         if (sdi->status != SR_ST_ACTIVE)
 645                 return SR_ERR;
 646
 647         return SR_OK;
 648 }
 649
 650 SR_PRIV struct dev_context *dslogic_dev_new(void)
 651 {
 652         struct dev_context *devc;
 653
 654         devc = g_malloc0(sizeof(struct dev_context));
 655         devc->profile = NULL;
 656         devc->fw_updated = 0;
 657         devc->cur_samplerate = 0;
 658         devc->limit_samples = 0;
 659         devc->capture_ratio = 0;
 660         devc->continuous_mode = FALSE;
 661         devc->clock_edge = DS_EDGE_RISING;
 662
 663         return devc;
 664 }
 665
 666 static void abort_acquisition(struct dev_context *devc)
 667 {
 668         int i;
 669
 670         devc->acq_aborted = TRUE;
 671
 672         for (i = devc->num_transfers - 1; i >= 0; i--) {
 673                 if (devc->transfers[i])
 674                         libusb_cancel_transfer(devc->transfers[i]);
 675         }
 676 }
 677
 678 static void finish_acquisition(struct sr_dev_inst *sdi)
 679 {
 680         struct dev_context *devc;
 681
 682         devc = sdi->priv;
 683
 684         std_session_send_df_end(sdi);
 685
 686         usb_source_remove(sdi->session, devc->ctx);
 687
 688         devc->num_transfers = 0;
 689         g_free(devc->transfers);
 690 }
 691
 692 static void free_transfer(struct libusb_transfer *transfer)
 693 {
 694         struct sr_dev_inst *sdi;
 695         struct dev_context *devc;
 696         unsigned int i;
 697
 698         sdi = transfer->user_data;
 699         devc = sdi->priv;
 700
 701         g_free(transfer->buffer);
 702         transfer->buffer = NULL;
 703         libusb_free_transfer(transfer);
 704
 705         for (i = 0; i < devc->num_transfers; i++) {
 706                 if (devc->transfers[i] == transfer) {
 707                         devc->transfers[i] = NULL;
 708                         break;
 709                 }
 710         }
 711
 712         devc->submitted_transfers--;
 713         if (devc->submitted_transfers == 0)
 714                 finish_acquisition(sdi);
 715 }
 716
 717 static void resubmit_transfer(struct libusb_transfer *transfer)
 718 {
 719         int ret;
 720
 721         if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
 722                 return;
 723
 724         sr_err("%s: %s", __func__, libusb_error_name(ret));
 725         free_transfer(transfer);
 726
 727 }
 728
 729 static void send_data(struct sr_dev_inst *sdi,
 730         uint8_t *data, size_t length, size_t sample_width)
 731 {
 732         const struct sr_datafeed_logic logic = {
 733                 .length = length,
 734                 .unitsize = sample_width,
 735                 .data = data
 736         };
 737
 738         const struct sr_datafeed_packet packet = {
 739                 .type = SR_DF_LOGIC,
 740                 .payload = &logic
 741         };
 742
 743         sr_session_send(sdi, &packet);
 744 }
 745
 746 static void LIBUSB_CALL receive_transfer(struct libusb_transfer *transfer)
 747 {
 748         struct sr_dev_inst *sdi;
 749         struct dev_context *devc;
 750         gboolean packet_has_error = FALSE;
 751         struct sr_datafeed_packet packet;
 752         unsigned int num_samples;
 753         int trigger_offset, cur_sample_count;
 754         const int unitsize = 2;
 755
 756         sdi = transfer->user_data;
 757         devc = sdi->priv;
 758
 759         /*
 760          * If acquisition has already ended, just free any queued up
 761          * transfer that come in.
 762          */
 763         if (devc->acq_aborted) {
 764                 free_transfer(transfer);
 765                 return;
 766         }
 767
 768         sr_dbg("receive_transfer(): status %s received %d bytes.",
 769                 libusb_error_name(transfer->status), transfer->actual_length);
 770
 771         /* Save incoming transfer before reusing the transfer struct. */
 772         cur_sample_count = transfer->actual_length / unitsize;
 773
 774         switch (transfer->status) {
 775         case LIBUSB_TRANSFER_NO_DEVICE:
 776                 abort_acquisition(devc);
 777                 free_transfer(transfer);
 778                 return;
 779         case LIBUSB_TRANSFER_COMPLETED:
 780         case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
 781                 break;
 782         default:
 783                 packet_has_error = TRUE;
 784                 break;
 785         }
 786
 787         if (transfer->actual_length == 0 || packet_has_error) {
 788                 devc->empty_transfer_count++;
 789                 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
 790                         /*
 791                          * The FX2 gave up. End the acquisition, the frontend
 792                          * will work out that the samplecount is short.
 793                          */
 794                         abort_acquisition(devc);
 795                         free_transfer(transfer);
 796                 } else {
 797                         resubmit_transfer(transfer);
 798                 }
 799                 return;
 800         } else {
 801                 devc->empty_transfer_count = 0;
 802         }
 803         if (devc->trigger_fired) {
 804                 if (!devc->limit_samples || devc->sent_samples < devc->limit_samples) {
 805                         /* Send the incoming transfer to the session bus. */
 806                         if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
 807                                 num_samples = devc->limit_samples - devc->sent_samples;
 808                         else
 809                                 num_samples = cur_sample_count;
 810
 811                         if (devc->trigger_pos > devc->sent_samples
 812                                 && devc->trigger_pos <= devc->sent_samples + num_samples) {
 813                                         /* DSLogic trigger in this block. Send trigger position. */
 814                                         trigger_offset = devc->trigger_pos - devc->sent_samples;
 815                                         /* Pre-trigger samples. */
 816                                         send_data(sdi, (uint8_t *)transfer->buffer,
 817                                                 trigger_offset * unitsize, unitsize);
 818                                         devc->sent_samples += trigger_offset;
 819                                         /* Trigger position. */
 820                                         devc->trigger_pos = 0;
 821                                         packet.type = SR_DF_TRIGGER;
 822                                         packet.payload = NULL;
 823                                         sr_session_send(sdi, &packet);
 824                                         /* Post trigger samples. */
 825                                         num_samples -= trigger_offset;
 826                                         send_data(sdi, (uint8_t *)transfer->buffer
 827                                                         + trigger_offset * unitsize, num_samples * unitsize, unitsize);
 828                                         devc->sent_samples += num_samples;
 829                         } else {
 830                                 send_data(sdi, (uint8_t *)transfer->buffer,
 831                                         num_samples * unitsize, unitsize);
 832                                 devc->sent_samples += num_samples;
 833                         }
 834                 }
 835         }
 836
 837         if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
 838                 abort_acquisition(devc);
 839                 free_transfer(transfer);
 840         } else
 841                 resubmit_transfer(transfer);
 842 }
 843
 844 static int receive_data(int fd, int revents, void *cb_data)
 845 {
 846         struct timeval tv;
 847         struct drv_context *drvc;
 848
 849         (void)fd;
 850         (void)revents;
 851
 852         drvc = (struct drv_context *)cb_data;
 853
 854         tv.tv_sec = tv.tv_usec = 0;
 855         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 856
 857         return TRUE;
 858 }
 859
 860 static unsigned int to_bytes_per_ms(unsigned int samplerate)
 861 {
 862         if (samplerate > SR_MHZ(100))
 863                 return SR_MHZ(100) / 1000 * 2;
 864         return samplerate / 1000 * 2;
 865 }
 866
 867 static size_t get_buffer_size(struct dev_context *devc)
 868 {
 869         /*
 870          * The buffer should be large enough to hold 10ms of data and
 871          * a multiple of 512.
 872          */
 873         const size_t s = 10 * to_bytes_per_ms(devc->cur_samplerate);
 874         return (s + 511) & ~511;
 875 }
 876
 877 static int get_number_of_transfers(struct dev_context *devc)
 878 {
 879         /* Total buffer size should be able to hold about 100ms of data. */
 880         const unsigned int n = (100 * to_bytes_per_ms(devc->cur_samplerate)) /
 881                 get_buffer_size(devc);
 882         sr_info("New calculation: %d", n);
 883
 884         if (n > NUM_SIMUL_TRANSFERS)
 885                 return NUM_SIMUL_TRANSFERS;
 886
 887         return n;
 888 }
 889
 890 static unsigned int get_timeout(struct dev_context *devc)
 891 {
 892         const size_t total_size = get_buffer_size(devc) *
 893                 get_number_of_transfers(devc);
 894         const unsigned int timeout =
 895                 total_size / to_bytes_per_ms(devc->cur_samplerate);
 896         return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
 897 }
 898
 899 static int start_transfers(const struct sr_dev_inst *sdi)
 900 {
 901         struct dev_context *devc;
 902         struct sr_usb_dev_inst *usb;
 903         struct libusb_transfer *transfer;
 904         unsigned int i, num_transfers;
 905         int timeout, ret;
 906         unsigned char *buf;
 907         size_t size;
 908
 909         devc = sdi->priv;
 910         usb = sdi->conn;
 911
 912         devc->sent_samples = 0;
 913         devc->acq_aborted = FALSE;
 914         devc->empty_transfer_count = 0;
 915         devc->trigger_fired = TRUE;
 916
 917         num_transfers = get_number_of_transfers(devc);
 918
 919         if (devc->cur_samplerate == SR_MHZ(100))
 920                 num_transfers = 16;
 921         else if (devc->cur_samplerate == SR_MHZ(200))
 922                 num_transfers = 8;
 923         else if (devc->cur_samplerate == SR_MHZ(400))
 924                 num_transfers = 4;
 925
 926         size = get_buffer_size(devc);
 927         devc->submitted_transfers = 0;
 928
 929         devc->transfers = g_try_malloc0(sizeof(*devc->transfers) * num_transfers);
 930         if (!devc->transfers) {
 931                 sr_err("USB transfers malloc failed.");
 932                 return SR_ERR_MALLOC;
 933         }
 934
 935         timeout = get_timeout(devc);
 936         devc->num_transfers = num_transfers;
 937         for (i = 0; i < num_transfers; i++) {
 938                 if (!(buf = g_try_malloc(size))) {
 939                         sr_err("USB transfer buffer malloc failed.");
 940                         return SR_ERR_MALLOC;
 941                 }
 942                 transfer = libusb_alloc_transfer(0);
 943                 libusb_fill_bulk_transfer(transfer, usb->devhdl,
 944                                 6 | LIBUSB_ENDPOINT_IN, buf, size,
 945                                 receive_transfer, (void *)sdi, timeout);
 946                 sr_info("submitting transfer: %d", i);
 947                 if ((ret = libusb_submit_transfer(transfer)) != 0) {
 948                         sr_err("Failed to submit transfer: %s.",
 949                                libusb_error_name(ret));
 950                         libusb_free_transfer(transfer);
 951                         g_free(buf);
 952                         abort_acquisition(devc);
 953                         return SR_ERR;
 954                 }
 955                 devc->transfers[i] = transfer;
 956                 devc->submitted_transfers++;
 957         }
 958
 959         std_session_send_df_header(sdi);
 960
 961         return SR_OK;
 962 }
 963
 964 static void LIBUSB_CALL trigger_receive(struct libusb_transfer *transfer)
 965 {
 966         const struct sr_dev_inst *sdi;
 967         struct dslogic_trigger_pos *tpos;
 968         struct dev_context *devc;
 969
 970         sdi = transfer->user_data;
 971         devc = sdi->priv;
 972         if (transfer->status == LIBUSB_TRANSFER_CANCELLED) {
 973                 sr_dbg("Trigger transfer canceled.");
 974                 /* Terminate session. */
 975                 std_session_send_df_end(sdi);
 976                 usb_source_remove(sdi->session, devc->ctx);
 977                 devc->num_transfers = 0;
 978                 g_free(devc->transfers);
 979         } else if (transfer->status == LIBUSB_TRANSFER_COMPLETED
 980                         && transfer->actual_length == sizeof(struct dslogic_trigger_pos)) {
 981                 tpos = (struct dslogic_trigger_pos *)transfer->buffer;
 982                 sr_info("tpos real_pos %d ram_saddr %d cnt %d", tpos->real_pos,
 983                         tpos->ram_saddr, tpos->remain_cnt);
 984                 devc->trigger_pos = tpos->real_pos;
 985                 g_free(tpos);
 986                 start_transfers(sdi);
 987         }
 988         libusb_free_transfer(transfer);
 989 }
 990
 991 static int trigger_request(const struct sr_dev_inst *sdi)
 992 {
 993         struct sr_usb_dev_inst *usb;
 994         struct libusb_transfer *transfer;
 995         struct dslogic_trigger_pos *tpos;
 996         struct dev_context *devc;
 997         int ret;
 998
 999         usb = sdi->conn;
1000         devc = sdi->priv;
1001
1002         if ((ret = command_stop_acquisition(sdi)) != SR_OK)
1003                 return ret;
1004
1005         if ((ret = fpga_configure(sdi)) != SR_OK)
1006                 return ret;
1007
1008         if ((ret = command_start_acquisition(sdi)) != SR_OK)
1009                 return ret;
1010
1011         sr_dbg("Getting trigger.");
1012         tpos = g_malloc(sizeof(struct dslogic_trigger_pos));
1013         transfer = libusb_alloc_transfer(0);
1014         libusb_fill_bulk_transfer(transfer, usb->devhdl, 6 | LIBUSB_ENDPOINT_IN,
1015                         (unsigned char *)tpos, sizeof(struct dslogic_trigger_pos),
1016                         trigger_receive, (void *)sdi, 0);
1017         if ((ret = libusb_submit_transfer(transfer)) < 0) {
1018                 sr_err("Failed to request trigger: %s.", libusb_error_name(ret));
1019                 libusb_free_transfer(transfer);
1020                 g_free(tpos);
1021                 return SR_ERR;
1022         }
1023
1024         devc->transfers = g_try_malloc0(sizeof(*devc->transfers));
1025         if (!devc->transfers) {
1026                 sr_err("USB trigger_pos transfer malloc failed.");
1027                 return SR_ERR_MALLOC;
1028         }
1029         devc->num_transfers = 1;
1030         devc->submitted_transfers++;
1031         devc->transfers[0] = transfer;
1032
1033         return ret;
1034 }
1035
1036 SR_PRIV int dslogic_acquisition_start(const struct sr_dev_inst *sdi)
1037 {
1038         struct sr_dev_driver *di;
1039         struct drv_context *drvc;
1040         struct dev_context *devc;
1041         int timeout;
1042
1043         if (sdi->status != SR_ST_ACTIVE)
1044                 return SR_ERR_DEV_CLOSED;
1045
1046         di = sdi->driver;
1047         drvc = di->context;
1048         devc = sdi->priv;
1049
1050         devc->ctx = drvc->sr_ctx;
1051         devc->sent_samples = 0;
1052         devc->empty_transfer_count = 0;
1053         devc->acq_aborted = FALSE;
1054
1055         timeout = get_timeout(devc);
1056         usb_source_add(sdi->session, devc->ctx, timeout, receive_data, drvc);
1057
1058         trigger_request(sdi);
1059
1060         return SR_OK;
1061 }
1062
1063 SR_PRIV int dslogic_acquisition_stop(struct sr_dev_inst *sdi)
1064 {
1065         command_stop_acquisition(sdi);
1066         abort_acquisition(sdi->priv);
1067         return SR_OK;
1068 }