src/hardware/fx2lafw/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 "protocol.h"
  22
  23 /* Protocol commands */
  24 #define CMD_GET_FW_VERSION              0xb0
  25 #define CMD_START                       0xb1
  26 #define CMD_GET_REVID_VERSION           0xb2
  27
  28 #define CMD_START_FLAGS_WIDE_POS        5
  29 #define CMD_START_FLAGS_CLK_SRC_POS     6
  30
  31 #define CMD_START_FLAGS_SAMPLE_8BIT     (0 << CMD_START_FLAGS_WIDE_POS)
  32 #define CMD_START_FLAGS_SAMPLE_16BIT    (1 << CMD_START_FLAGS_WIDE_POS)
  33
  34 #define CMD_START_FLAGS_CLK_30MHZ       (0 << CMD_START_FLAGS_CLK_SRC_POS)
  35 #define CMD_START_FLAGS_CLK_48MHZ       (1 << CMD_START_FLAGS_CLK_SRC_POS)
  36
  37 #pragma pack(push, 1)
  38
  39 struct version_info {
  40         uint8_t major;
  41         uint8_t minor;
  42 };
  43
  44 struct cmd_start_acquisition {
  45         uint8_t flags;
  46         uint8_t sample_delay_h;
  47         uint8_t sample_delay_l;
  48 };
  49
  50 #pragma pack(pop)
  51
  52 static int command_get_fw_version(libusb_device_handle *devhdl,
  53                                   struct version_info *vi)
  54 {
  55         int ret;
  56
  57         ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
  58                 LIBUSB_ENDPOINT_IN, CMD_GET_FW_VERSION, 0x0000, 0x0000,
  59                 (unsigned char *)vi, sizeof(struct version_info), 100);
  60
  61         if (ret < 0) {
  62                 sr_err("Unable to get version info: %s.",
  63                        libusb_error_name(ret));
  64                 return SR_ERR;
  65         }
  66
  67         return SR_OK;
  68 }
  69
  70 static int command_get_revid_version(struct sr_dev_inst *sdi, uint8_t *revid)
  71 {
  72         struct sr_usb_dev_inst *usb = sdi->conn;
  73         libusb_device_handle *devhdl = usb->devhdl;
  74         int ret;
  75
  76         ret = libusb_control_transfer(devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
  77                 LIBUSB_ENDPOINT_IN, CMD_GET_REVID_VERSION, 0x0000, 0x0000,
  78                 revid, 1, 100);
  79
  80         if (ret < 0) {
  81                 sr_err("Unable to get REVID: %s.", libusb_error_name(ret));
  82                 return SR_ERR;
  83         }
  84
  85         return SR_OK;
  86 }
  87
  88 SR_PRIV int fx2lafw_command_start_acquisition(const struct sr_dev_inst *sdi)
  89 {
  90         struct dev_context *devc;
  91         struct sr_usb_dev_inst *usb;
  92         uint64_t samplerate;
  93         struct cmd_start_acquisition cmd;
  94         int delay, ret;
  95
  96         devc = sdi->priv;
  97         usb = sdi->conn;
  98         samplerate = devc->cur_samplerate;
  99
 100         /* Compute the sample rate. */
 101         if (devc->sample_wide && samplerate > MAX_16BIT_SAMPLE_RATE) {
 102                 sr_err("Unable to sample at %" PRIu64 "Hz "
 103                        "when collecting 16-bit samples.", samplerate);
 104                 return SR_ERR;
 105         }
 106
 107         delay = 0;
 108         cmd.flags = cmd.sample_delay_h = cmd.sample_delay_l = 0;
 109         if ((SR_MHZ(48) % samplerate) == 0) {
 110                 cmd.flags = CMD_START_FLAGS_CLK_48MHZ;
 111                 delay = SR_MHZ(48) / samplerate - 1;
 112                 if (delay > MAX_SAMPLE_DELAY)
 113                         delay = 0;
 114         }
 115
 116         if (delay == 0 && (SR_MHZ(30) % samplerate) == 0) {
 117                 cmd.flags = CMD_START_FLAGS_CLK_30MHZ;
 118                 delay = SR_MHZ(30) / samplerate - 1;
 119         }
 120
 121         sr_info("GPIF delay = %d, clocksource = %sMHz.", delay,
 122                 (cmd.flags & CMD_START_FLAGS_CLK_48MHZ) ? "48" : "30");
 123
 124         if (delay <= 0 || delay > MAX_SAMPLE_DELAY) {
 125                 sr_err("Unable to sample at %" PRIu64 "Hz.", samplerate);
 126                 return SR_ERR;
 127         }
 128
 129         cmd.sample_delay_h = (delay >> 8) & 0xff;
 130         cmd.sample_delay_l = delay & 0xff;
 131
 132         /* Select the sampling width. */
 133         cmd.flags |= devc->sample_wide ? CMD_START_FLAGS_SAMPLE_16BIT :
 134                 CMD_START_FLAGS_SAMPLE_8BIT;
 135
 136         /* Send the control message. */
 137         ret = libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR |
 138                         LIBUSB_ENDPOINT_OUT, CMD_START, 0x0000, 0x0000,
 139                         (unsigned char *)&cmd, sizeof(cmd), 100);
 140         if (ret < 0) {
 141                 sr_err("Unable to send start command: %s.",
 142                        libusb_error_name(ret));
 143                 return SR_ERR;
 144         }
 145
 146         return SR_OK;
 147 }
 148
 149 /**
 150  * Check the USB configuration to determine if this is an fx2lafw device.
 151  *
 152  * @return TRUE if the device's configuration profile match fx2lafw
 153  *         configuration, FALSE otherwise.
 154  */
 155 SR_PRIV gboolean fx2lafw_check_conf_profile(libusb_device *dev)
 156 {
 157         struct libusb_device_descriptor des;
 158         struct libusb_device_handle *hdl;
 159         gboolean ret;
 160         unsigned char strdesc[64];
 161
 162         hdl = NULL;
 163         ret = FALSE;
 164         while (!ret) {
 165                 /* Assume the FW has not been loaded, unless proven wrong. */
 166                 if (libusb_get_device_descriptor(dev, &des) != 0)
 167                         break;
 168
 169                 if (libusb_open(dev, &hdl) != 0)
 170                         break;
 171
 172                 if (libusb_get_string_descriptor_ascii(hdl,
 173                     des.iManufacturer, strdesc, sizeof(strdesc)) < 0)
 174                         break;
 175                 if (strncmp((const char *)strdesc, "sigrok", 6))
 176                         break;
 177
 178                 if (libusb_get_string_descriptor_ascii(hdl,
 179                                 des.iProduct, strdesc, sizeof(strdesc)) < 0)
 180                         break;
 181                 if (strncmp((const char *)strdesc, "fx2lafw", 7))
 182                         break;
 183
 184                 /* If we made it here, it must be an fx2lafw. */
 185                 ret = TRUE;
 186         }
 187         if (hdl)
 188                 libusb_close(hdl);
 189
 190         return ret;
 191 }
 192
 193 SR_PRIV int fx2lafw_dev_open(struct sr_dev_inst *sdi, struct sr_dev_driver *di)
 194 {
 195         libusb_device **devlist;
 196         struct sr_usb_dev_inst *usb;
 197         struct libusb_device_descriptor des;
 198         struct dev_context *devc;
 199         struct drv_context *drvc;
 200         struct version_info vi;
 201         int ret, i, device_count;
 202         uint8_t revid;
 203         char connection_id[64];
 204
 205         drvc = di->priv;
 206         devc = sdi->priv;
 207         usb = sdi->conn;
 208
 209         if (sdi->status == SR_ST_ACTIVE)
 210                 /* Device is already in use. */
 211                 return SR_ERR;
 212
 213         device_count = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 214         if (device_count < 0) {
 215                 sr_err("Failed to get device list: %s.",
 216                        libusb_error_name(device_count));
 217                 return SR_ERR;
 218         }
 219
 220         for (i = 0; i < device_count; i++) {
 221                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 222                         sr_err("Failed to get device descriptor: %s.",
 223                                libusb_error_name(ret));
 224                         continue;
 225                 }
 226
 227                 if (des.idVendor != devc->profile->vid
 228                     || des.idProduct != devc->profile->pid)
 229                         continue;
 230
 231                 if ((sdi->status == SR_ST_INITIALIZING) ||
 232                                 (sdi->status == SR_ST_INACTIVE)) {
 233                         /*
 234                          * Check device by its physical USB bus/port address.
 235                          */
 236                         usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 237                         if (strcmp(sdi->connection_id, connection_id))
 238                                 /* This is not the one. */
 239                                 continue;
 240                 }
 241
 242                 if (!(ret = libusb_open(devlist[i], &usb->devhdl))) {
 243                         if (usb->address == 0xff)
 244                                 /*
 245                                  * First time we touch this device after FW
 246                                  * upload, so we don't know the address yet.
 247                                  */
 248                                 usb->address = libusb_get_device_address(devlist[i]);
 249                 } else {
 250                         sr_err("Failed to open device: %s.",
 251                                libusb_error_name(ret));
 252                         break;
 253                 }
 254
 255                 ret = command_get_fw_version(usb->devhdl, &vi);
 256                 if (ret != SR_OK) {
 257                         sr_err("Failed to get firmware version.");
 258                         break;
 259                 }
 260
 261                 ret = command_get_revid_version(sdi, &revid);
 262                 if (ret != SR_OK) {
 263                         sr_err("Failed to get REVID.");
 264                         break;
 265                 }
 266
 267                 /*
 268                  * Changes in major version mean incompatible/API changes, so
 269                  * bail out if we encounter an incompatible version.
 270                  * Different minor versions are OK, they should be compatible.
 271                  */
 272                 if (vi.major != FX2LAFW_REQUIRED_VERSION_MAJOR) {
 273                         sr_err("Expected firmware version %d.x, "
 274                                "got %d.%d.", FX2LAFW_REQUIRED_VERSION_MAJOR,
 275                                vi.major, vi.minor);
 276                         break;
 277                 }
 278
 279                 sdi->status = SR_ST_ACTIVE;
 280                 sr_info("Opened device on %d.%d (logical) / %s (physical), "
 281                         "interface %d, firmware %d.%d.",
 282                         usb->bus, usb->address, connection_id,
 283                         USB_INTERFACE, vi.major, vi.minor);
 284
 285                 sr_info("Detected REVID=%d, it's a Cypress CY7C68013%s.",
 286                         revid, (revid != 1) ? " (FX2)" : "A (FX2LP)");
 287
 288                 break;
 289         }
 290         libusb_free_device_list(devlist, 1);
 291
 292         if (sdi->status != SR_ST_ACTIVE)
 293                 return SR_ERR;
 294
 295         return SR_OK;
 296 }
 297
 298 SR_PRIV struct dev_context *fx2lafw_dev_new(void)
 299 {
 300         struct dev_context *devc;
 301
 302         devc = g_malloc0(sizeof(struct dev_context));
 303         devc->profile = NULL;
 304         devc->fw_updated = 0;
 305         devc->cur_samplerate = 0;
 306         devc->limit_samples = 0;
 307         devc->capture_ratio = 0;
 308         devc->sample_wide = FALSE;
 309         devc->stl = NULL;
 310
 311         return devc;
 312 }
 313
 314 SR_PRIV void fx2lafw_abort_acquisition(struct dev_context *devc)
 315 {
 316         int i;
 317
 318         devc->acq_aborted = TRUE;
 319
 320         for (i = devc->num_transfers - 1; i >= 0; i--) {
 321                 if (devc->transfers[i])
 322                         libusb_cancel_transfer(devc->transfers[i]);
 323         }
 324 }
 325
 326 static void finish_acquisition(struct sr_dev_inst *sdi)
 327 {
 328         struct sr_datafeed_packet packet;
 329         struct dev_context *devc;
 330
 331         devc = sdi->priv;
 332
 333         /* Terminate session. */
 334         packet.type = SR_DF_END;
 335         sr_session_send(sdi, &packet);
 336
 337         /* Remove fds from polling. */
 338         usb_source_remove(sdi->session, devc->ctx);
 339
 340         devc->num_transfers = 0;
 341         g_free(devc->transfers);
 342
 343         if (devc->stl) {
 344                 soft_trigger_logic_free(devc->stl);
 345                 devc->stl = NULL;
 346         }
 347 }
 348
 349 static void free_transfer(struct libusb_transfer *transfer)
 350 {
 351         struct sr_dev_inst *sdi;
 352         struct dev_context *devc;
 353         unsigned int i;
 354
 355         sdi = transfer->user_data;
 356         devc = sdi->priv;
 357
 358         g_free(transfer->buffer);
 359         transfer->buffer = NULL;
 360         libusb_free_transfer(transfer);
 361
 362         for (i = 0; i < devc->num_transfers; i++) {
 363                 if (devc->transfers[i] == transfer) {
 364                         devc->transfers[i] = NULL;
 365                         break;
 366                 }
 367         }
 368
 369         devc->submitted_transfers--;
 370         if (devc->submitted_transfers == 0)
 371                 finish_acquisition(sdi);
 372 }
 373
 374 static void resubmit_transfer(struct libusb_transfer *transfer)
 375 {
 376         int ret;
 377
 378         if ((ret = libusb_submit_transfer(transfer)) == LIBUSB_SUCCESS)
 379                 return;
 380
 381         sr_err("%s: %s", __func__, libusb_error_name(ret));
 382         free_transfer(transfer);
 383
 384 }
 385
 386 SR_PRIV void fx2lafw_receive_transfer(struct libusb_transfer *transfer)
 387 {
 388         struct sr_dev_inst *sdi;
 389         struct dev_context *devc;
 390         gboolean packet_has_error = FALSE;
 391         struct sr_datafeed_packet packet;
 392         struct sr_datafeed_logic logic;
 393         unsigned int num_samples;
 394         int trigger_offset, cur_sample_count, unitsize;
 395         int pre_trigger_samples;
 396
 397         sdi = transfer->user_data;
 398         devc = sdi->priv;
 399
 400         /*
 401          * If acquisition has already ended, just free any queued up
 402          * transfer that come in.
 403          */
 404         if (devc->acq_aborted) {
 405                 free_transfer(transfer);
 406                 return;
 407         }
 408
 409         sr_info("receive_transfer(): status %d received %d bytes.",
 410                 transfer->status, transfer->actual_length);
 411
 412         /* Save incoming transfer before reusing the transfer struct. */
 413         unitsize = devc->sample_wide ? 2 : 1;
 414         cur_sample_count = transfer->actual_length / unitsize;
 415
 416         switch (transfer->status) {
 417         case LIBUSB_TRANSFER_NO_DEVICE:
 418                 fx2lafw_abort_acquisition(devc);
 419                 free_transfer(transfer);
 420                 return;
 421         case LIBUSB_TRANSFER_COMPLETED:
 422         case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though. */
 423                 break;
 424         default:
 425                 packet_has_error = TRUE;
 426                 break;
 427         }
 428
 429         if (transfer->actual_length == 0 || packet_has_error) {
 430                 devc->empty_transfer_count++;
 431                 if (devc->empty_transfer_count > MAX_EMPTY_TRANSFERS) {
 432                         /*
 433                          * The FX2 gave up. End the acquisition, the frontend
 434                          * will work out that the samplecount is short.
 435                          */
 436                         fx2lafw_abort_acquisition(devc);
 437                         free_transfer(transfer);
 438                 } else {
 439                         resubmit_transfer(transfer);
 440                 }
 441                 return;
 442         } else {
 443                 devc->empty_transfer_count = 0;
 444         }
 445
 446         if (devc->trigger_fired) {
 447                 if (!devc->limit_samples || devc->sent_samples < devc->limit_samples) {
 448                         /* Send the incoming transfer to the session bus. */
 449                         packet.type = SR_DF_LOGIC;
 450                         packet.payload = &logic;
 451                         if (devc->limit_samples && devc->sent_samples + cur_sample_count > devc->limit_samples)
 452                                 num_samples = devc->limit_samples - devc->sent_samples;
 453                         else
 454                                 num_samples = cur_sample_count;
 455                         logic.length = num_samples * unitsize;
 456                         logic.unitsize = unitsize;
 457                         logic.data = transfer->buffer;
 458                         sr_session_send(devc->cb_data, &packet);
 459                         devc->sent_samples += num_samples;
 460                 }
 461         } else {
 462                 trigger_offset = soft_trigger_logic_check(devc->stl,
 463                         transfer->buffer, transfer->actual_length, &pre_trigger_samples);
 464                 if (trigger_offset > -1) {
 465                         devc->sent_samples += pre_trigger_samples;
 466                         packet.type = SR_DF_LOGIC;
 467                         packet.payload = &logic;
 468                         num_samples = cur_sample_count - trigger_offset;
 469                         if (devc->limit_samples &&
 470                                         num_samples > devc->limit_samples - devc->sent_samples)
 471                                 num_samples = devc->limit_samples - devc->sent_samples;
 472                         logic.length = num_samples * unitsize;
 473                         logic.unitsize = unitsize;
 474                         logic.data = transfer->buffer + trigger_offset * unitsize;
 475                         sr_session_send(devc->cb_data, &packet);
 476                         devc->sent_samples += num_samples;
 477
 478                         devc->trigger_fired = TRUE;
 479                 }
 480         }
 481
 482         if (devc->limit_samples && devc->sent_samples >= devc->limit_samples) {
 483                 fx2lafw_abort_acquisition(devc);
 484                 free_transfer(transfer);
 485         } else
 486                 resubmit_transfer(transfer);
 487 }
 488
 489 static unsigned int to_bytes_per_ms(unsigned int samplerate)
 490 {
 491         return samplerate / 1000;
 492 }
 493
 494 SR_PRIV size_t fx2lafw_get_buffer_size(struct dev_context *devc)
 495 {
 496         size_t s;
 497
 498         /*
 499          * The buffer should be large enough to hold 10ms of data and
 500          * a multiple of 512.
 501          */
 502         s = 10 * to_bytes_per_ms(devc->cur_samplerate);
 503         return (s + 511) & ~511;
 504 }
 505
 506 SR_PRIV unsigned int fx2lafw_get_number_of_transfers(struct dev_context *devc)
 507 {
 508         unsigned int n;
 509
 510         /* Total buffer size should be able to hold about 500ms of data. */
 511         n = (500 * to_bytes_per_ms(devc->cur_samplerate) /
 512                 fx2lafw_get_buffer_size(devc));
 513
 514         if (n > NUM_SIMUL_TRANSFERS)
 515                 return NUM_SIMUL_TRANSFERS;
 516
 517         return n;
 518 }
 519
 520 SR_PRIV unsigned int fx2lafw_get_timeout(struct dev_context *devc)
 521 {
 522         size_t total_size;
 523         unsigned int timeout;
 524
 525         total_size = fx2lafw_get_buffer_size(devc) *
 526                         fx2lafw_get_number_of_transfers(devc);
 527         timeout = total_size / to_bytes_per_ms(devc->cur_samplerate);
 528         return timeout + timeout / 4; /* Leave a headroom of 25% percent. */
 529 }